<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[7042] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-stripe-client.php: Stripe Client: Add more granular error messages to help troubleshoot.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/7042">7042</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/7042","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-04-05 22:47:27 +0000 (Thu, 05 Apr 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Stripe Client: Add more granular error messages to help troubleshoot.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassstripeclientphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-stripe-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassstripeclientphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-stripe-client.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-stripe-client.php 2018-04-05 20:01:26 UTC (rev 7041)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-stripe-client.php 2018-04-05 22:47:27 UTC (rev 7042)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,6 +15,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Stripe_Client {
</span><span class="cx" style="display: block; padding: 0 10px"> const API_URL = 'https://api.stripe.com';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ const AMOUNT_MAX = 99999999;
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $secret_key;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +36,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $headers Optionally add extra headers to the request, like `Idempotency-Key`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return object
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @throws Exception
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function charge( $body, $headers = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,20 +56,100 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'headers' => $headers,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Stripe doesn't allow amounts larger than `AMOUNT_MAX`, even in currencies where that's the equivalent of less than $5k USD.
+ *
+ * The amount in the error message is converted back to the base unit, to avoid confusing the user.
+ *
+ * See https://botbot.me/freenode/stripe/msg/47523902/.
+ * See https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts.
+ */
+ if ( isset( $request_args['body']['amount'] ) && $request_args['body']['amount'] > self::AMOUNT_MAX ) {
+ throw new Exception( sprintf(
+ __( "We're sorry, but we can't accept amounts larger than %s. Please send the equivalent in USD, or break it up into several smaller payments. Feel free to email <a href='mailto:%s'>%s</a> with any questions.", 'wordcamporg' ),
+ number_format( self::AMOUNT_MAX / self::get_fractional_unit_multiplier( $request_args['body']['currency'] ), 2 ),
+ EMAIL_CENTRAL_SUPPORT,
+ EMAIL_CENTRAL_SUPPORT
+ ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = wp_remote_post( self::API_URL . '/v1/charges', $request_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $response ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- Logger\log( 'response_error', $response );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'response_error', compact( 'response' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> throw new Exception( $response->get_error_message() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $body = json_decode( wp_remote_retrieve_body( $response ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Declined cards are the most common type of error, so informing the user that it was declined should
+ * significantly cut down on support requests.
+ */
+ if ( isset( $body->error->type ) && 'card_error' === $body->error->type ) {
+ throw new Exception( sprintf(
+ __( "We're sorry, but that card was declined by the issuer, please try another. You can also contact the card issuer to find out why they declined it, or email <a href='mailto:%s'>%s</a> with any other questions.", 'wordcamporg' ),
+ EMAIL_CENTRAL_SUPPORT,
+ EMAIL_CENTRAL_SUPPORT
+ ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $body->id ) || empty( $body->paid ) || ! $body->paid ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- Logger\log( 'unexpected_response_body', $response );
- throw new Exception( 'Unexpected response body.' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ Logger\log( 'unexpected_response_body', compact( 'response' ) );
+ throw new Exception( sprintf(
+ __( "We're sorry, but we encountered an error trying to process that transaction. Please email <a href='mailto:%s'>%s</a> for help.", 'wordcamporg' ),
+ EMAIL_CENTRAL_SUPPORT,
+ EMAIL_CENTRAL_SUPPORT
+ ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $body;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Get the multiplier needed to convert a currency's base unit to its equivalent fractional unit.
+ *
+ * Stripe wants amounts in the fractional unit (e.g., pennies), not the base unit (e.g., dollars). Zero-decimal
+ * currencies are not included here, because they're not supported at all yet.
+ *
+ * The data here comes from https://en.wikipedia.org/wiki/List_of_circulating_currencies.
+ *
+ * @param string $order_currency
+ *
+ * @return int
+ *
+ * @throws Exception
+ */
+ public static function get_fractional_unit_multiplier( $order_currency ) {
+ $match = null;
+
+ $currency_multipliers = array(
+ 5 => array( 'MRO', 'MRU' ),
+ 100 => array(
+ 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN',
+ 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN', 'BZD', 'CAD', 'CDF', 'CHF', 'CNY', 'COP',
+ 'CRC', 'CUC', 'CUP', 'CVE', 'CZK', 'DKK', 'DOP', 'DZD', 'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP',
+ 'GBP', 'GEL', 'GGP', 'GHS', 'GIP', 'GMD', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR',
+ 'ILS', 'IMP', 'INR', 'IRR', 'ISK', 'JEP', 'JMD', 'JOD', 'KES', 'KGS', 'KHR', 'KPW', 'KYD', 'KZT',
+ 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'MAD', 'MDL', 'MKD', 'MMK', 'MNT', 'MOP', 'MUR', 'MVR', 'MWK',
+ 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR',
+ 'PLN', 'PRB', 'QAR', 'RON', 'RSD', 'RUB', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL',
+ 'SOS', 'SRD', 'SSP', 'STD', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TOP', 'TRY', 'TTD', 'TVD', 'TWD',
+ 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'WST', 'XCD', 'YER', 'ZAR', 'ZMW',
+ ),
+ 1000 => array( 'BHD', 'IQD', 'KWD', 'LYD', 'OMR', 'TND' ),
+ );
+
+ foreach ( $currency_multipliers as $multiplier => $currencies ) {
+ if ( in_array( $order_currency, $currencies, true ) ) {
+ $match = $multiplier;
+ }
+ }
+
+ if ( is_null( $match ) ) {
+ throw new Exception( "Unknown currency multiplier for $order_currency." );
+ }
+
+ return $match;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>