Changeset 7271 for sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php

Timestamp:

06/06/2018 12:08:53 AM (8 years ago)

Author:

coreymckrill

Message:

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.

File:

• sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php (modified) (11 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-currency-xrt-client.php

@@ -8 +8 @@
  *
  * Get historical exchange rates for the major currencies. Designed to be able to use different API sources for
- * the exchange rate data. Initially built using the Fixer API (fixer.io). "XRT" = "exchange rate".
+ * the exchange rate data. Initially built using the Fixer API (fixer.io). Now includes Open Exchange Rates.
+ * "XRT" = "exchange rate".
  */
 class Currency_XRT_Client {
@@ -32 +33 @@
 
         /**
+         * @var string The key for accessing the source's API.
+         */
+        protected $api_key = '';
+
+        /**
          * @var array Cache of exchange rates by date for reuse.
          */
@@ -40 +46 @@
          *
          * @param string $base_currency Optional. Currency symbol for the base currency. Default 'USD'.
-         * @param string $source        Optional. Identifier for the exchange rates source. Default 'fixer'.
-         */
-        public function __construct( $base_currency = 'USD', $source = 'fixer' ) {
+         * @param string $source        Optional. Identifier for the exchange rates source. Default 'oxr'.
+         */
+        public function __construct( $base_currency = 'USD', $source = 'oxr' ) {
                 $this->error = new \WP_Error();
 
@@ -48 +54 @@
                 $this->source        = $source;
                 $this->api_base      = $this->get_api_base( $this->source );
+                $this->api_key       = $this->get_api_key( $this->source );
         }
 
@@ -62 +69 @@
                 switch ( $source ) {
                         case 'fixer' :
-                        default :
-                                $base_url = 'https://api.fixer.io/';
+                                $base_url = 'https://data.fixer.io/api/';
+                                break;
+                        case 'oxr' :
+                                $base_url = 'https://openexchangerates.org/api/';
                                 break;
                 }
 
                 return trailingslashit( $base_url );
+        }
+
+        /**
+         * 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;
         }
 
@@ -79 +114 @@
         public function get_rates( $date ) {
                 $rates = array();
-                $cache_key = 'wc_currency_rates_' . strtotime( $date );
+                $cache_key = 'wc_currency_rates_' . $this->source . '_' . strtotime( $date );
 
                 try {
@@ -97 +132 @@
                 switch ( $this->source ) {
                         case 'fixer' :
+                                $rates = $this->send_fixer_request( $date );
+                                break;
+                        case 'oxr' :
+                                $rates = $this->send_oxr_request( $date );
+                                break;
                         default :
-                                $rates = $this->send_fixer_request( $date );
+                                $rates = new \WP_Error(
+                                        'invalid_xrt_source',
+                                        sprintf(
+                                                '%s is not a valid currency exchange rate source.',
+                                                esc_html( $this->source )
+                                        )
+                                );
                                 break;
                 }
@@ -178 +224 @@
                 $data = array();
 
-                $request_url = add_query_arg( array(
-                        'base' => $this->base_currency,
-                ), $this->api_base . $date->format( 'Y-m-d' ) );
+                $api_endpoint = $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(
+                                'access_key' => $this->api_key,
+                                'base'       => $this->base_currency,
+                        ),
+                        esc_url( $this->api_base . $api_endpoint )
+                );
 
                 $response      = wcorg_redundant_remote_get( $request_url );
@@ -192 +249 @@
                                 $this->error->add(
                                         'request_error',
-                                        $response_body['error']
+                                        sprintf(
+                                                '%s: %s',
+                                                $response_body['error']['code'],
+                                                $response_body['error']['info']
+                                        )
                                 );
                         } else {
@@ -201 +262 @@
                         }
                 } else {
-                        $this->error->add(
-                                'http_response_code',
-                                $response_code . ': ' . print_r( $response_body, true )
-                        );
+                        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 )
+                                );
+                        }
                 }
 
@@ -213 +285 @@
                 return $data;
         }
+
+        /**
+         * 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;
+        }
 }