<!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>[7271] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php: WordCamp Utilities: Add oxr as current exchange rate source</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/7271">7271</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/7271","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-06-06 00:08:53 +0000 (Wed, 06 Jun 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'>WordCamp Utilities: Add oxr as current exchange rate source
Fixer has a new API that does not meet our needs with the free plan.
Open Exchange Rates has a very similar API that seems to do everything we need.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclasscurrencyxrtclientphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclasscurrencyxrtclientphp"></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-currency-xrt-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-currency-xrt-client.php 2018-06-05 22:28:46 UTC (rev 7270)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php 2018-06-06 00:08:53 UTC (rev 7271)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -7,7 +7,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Class Currency_XRT_Client
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Get historical exchange rates for the major currencies. Designed to be able to use different API sources for
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the exchange rate data. Initially built using the Fixer API (fixer.io). "XRT" = "exchange rate".
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the exchange rate data. Initially built using the Fixer API (fixer.io). Now includes Open Exchange Rates.
+ * "XRT" = "exchange rate".
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Currency_XRT_Client {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,6 +32,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $api_base = '';
</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">+ * @var string The key for accessing the source's API.
+ */
+ protected $api_key = '';
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @var array Cache of exchange rates by date for reuse.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected $cache = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,14 +45,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Currency_XRT_Client constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $base_currency Optional. Currency symbol for the base currency. Default 'USD'.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $source Optional. Identifier for the exchange rates source. Default 'fixer'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $source Optional. Identifier for the exchange rates source. Default 'oxr'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function __construct( $base_currency = 'USD', $source = 'fixer' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function __construct( $base_currency = 'USD', $source = 'oxr' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->error = new \WP_Error();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->base_currency = $base_currency;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->source = $source;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->api_base = $this->get_api_base( $this->source );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->api_key = $this->get_api_key( $this->source );
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,9 +68,11 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $source ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'fixer' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- default :
- $base_url = 'https://api.fixer.io/';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $base_url = 'https://data.fixer.io/api/';
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'oxr' :
+ $base_url = 'https://openexchangerates.org/api/';
+ break;
</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 trailingslashit( $base_url );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -70,6 +79,32 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get the API key based on the given source.
+ *
+ * @param string $source
+ *
+ * @return string The API key.
+ */
+ protected function get_api_key( $source ) {
+ $key = '';
+
+ switch ( $source ) {
+ case 'fixer' :
+ if ( defined( 'WORDCAMP_FIXER_API_KEY' ) ) {
+ $key = WORDCAMP_FIXER_API_KEY;
+ }
+ break;
+ case 'oxr' :
+ if ( defined( 'WORDCAMP_OXR_API_KEY' ) ) {
+ $key = WORDCAMP_OXR_API_KEY;
+ }
+ break;
+ }
+
+ return $key;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the currency exchange rates for a particular date.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $date The date to retrieve the rates for.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,7 +113,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_rates( $date ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $rates = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cache_key = 'wc_currency_rates_' . strtotime( $date );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache_key = 'wc_currency_rates_' . $this->source . '_' . strtotime( $date );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><span class="cx" style="display: block; padding: 0 10px"> $date = new \DateTime( $date );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -96,9 +131,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $this->source ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'fixer' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- default :
</del><span class="cx" style="display: block; padding: 0 10px"> $rates = $this->send_fixer_request( $date );
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'oxr' :
+ $rates = $this->send_oxr_request( $date );
+ break;
+ default :
+ $rates = new \WP_Error(
+ 'invalid_xrt_source',
+ sprintf(
+ '%s is not a valid currency exchange rate source.',
+ esc_html( $this->source )
+ )
+ );
+ break;
</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"> if ( is_wp_error( $rates ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -177,10 +223,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function send_fixer_request( \DateTime $date ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $request_url = add_query_arg( array(
- 'base' => $this->base_currency,
- ), $this->api_base . $date->format( 'Y-m-d' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $api_endpoint = $date->format( 'Y-m-d' );
+ $now = new \DateTime();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $date->format( 'Y-m-d' ) === $now->format( 'Y-m-d' ) || $date > $now ) {
+ $api_endpoint = 'latest';
+ }
+
+ $request_url = add_query_arg(
+ array(
+ 'access_key' => $this->api_key,
+ 'base' => $this->base_currency,
+ ),
+ esc_url( $this->api_base . $api_endpoint )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = wcorg_redundant_remote_get( $request_url );
</span><span class="cx" style="display: block; padding: 0 10px"> $response_code = wp_remote_retrieve_response_code( $response );
</span><span class="cx" style="display: block; padding: 0 10px"> $response_body = json_decode( wp_remote_retrieve_body( $response ), true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,7 +248,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( isset( $response_body['error'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->error->add(
</span><span class="cx" style="display: block; padding: 0 10px"> 'request_error',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response_body['error']
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ sprintf(
+ '%s: %s',
+ $response_body['error']['code'],
+ $response_body['error']['info']
+ )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->error->add(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,10 +261,21 @@
</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"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->error->add(
- 'http_response_code',
- $response_code . ': ' . print_r( $response_body, true )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $response_body['error'] ) ) {
+ $this->error->add(
+ 'request_error',
+ sprintf(
+ '%s: %s',
+ $response_body['error']['code'],
+ $response_body['error']['info']
+ )
+ );
+ } else {
+ $this->error->add(
+ 'http_response_code',
+ $response_code . ': ' . print_r( $response_body, true )
+ );
+ }
</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"> if ( ! empty( $this->error->get_error_messages() ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -212,4 +284,63 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Send a request to the Open Exchange Rates API and return the results.
+ *
+ * @param \DateTime $date The date to retrieve rates for.
+ *
+ * @return array|\WP_Error An array of rates, or an error.
+ */
+ protected function send_oxr_request( \DateTime $date ) {
+ $data = array();
+
+ $api_endpoint = 'historical/' . $date->format( 'Y-m-d' );
+ $now = new \DateTime();
+
+ if ( $date->format( 'Y-m-d' ) === $now->format( 'Y-m-d' ) || $date > $now ) {
+ $api_endpoint = 'latest';
+ }
+
+ $request_url = add_query_arg(
+ array(
+ 'app_id' => $this->api_key,
+ 'base' => $this->base_currency,
+ ),
+ esc_url( sprintf( '%s%s.json', $this->api_base, $api_endpoint ) )
+ );
+
+ $response = wcorg_redundant_remote_get( $request_url );
+ $response_code = wp_remote_retrieve_response_code( $response );
+ $response_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+ if ( 200 === $response_code ) {
+ if ( isset( $response_body['rates'] ) ) {
+ $data = $response_body['rates'];
+ } else {
+ $this->error->add(
+ 'unexpected_response_data',
+ 'The API response did not provide the expected data.'
+ );
+ }
+ } else {
+ if ( isset( $response_body['error'], $response_body['message'], $response_body['description'] ) ) {
+ $this->error->add(
+ esc_html( $response_body['message'] ),
+ esc_html( $response_body['description'] )
+ );
+ } else {
+ $this->error->add(
+ 'http_response_code',
+ $response_code . ': ' . print_r( $response_body, true )
+ );
+ }
+ }
+
+ if ( ! empty( $this->error->get_error_messages() ) ) {
+ return $this->error;
+ }
+
+ return $data;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>