Added Yahoo! Finance web service as an adapter

Author: jdambacher

.gitignore

@@ -104,4 +104,18 @@ public function createOerAdapter($adapterClass = null)
 
         return $this->create($adapterClass);
     }
+
+    /**
+     * Create an YahooCurrencyAdapter.
+     *
+     * @return Lexik\Bundle\CurrencyBundle\Adapter\YahooCurrencyAdapter
+     */
+    public function createYahooAdapter($adapterClass = null)
+    {
+        if (null == $adapterClass) {
+            $adapterClass = 'Lexik\Bundle\CurrencyBundle\Adapter\YahooCurrencyAdapter';
+        }
+
+        return $this->create($adapterClass);
+    }
 }

.travis.yml

@@ -0,0 +1,134 @@
+<?php
+
+namespace Lexik\Bundle\CurrencyBundle\Adapter;
+
+use Lexik\Bundle\CurrencyBundle\Exception\CurrencyNotFoundException;
+
+/**
+ * Yahoo! Adapter
+ *
+ * @author Jonas Dambacher <[email protected]>
+ */
+class YahooCurrencyAdapter extends AbstractCurrencyAdapter
+{
+    /**
+     * @var string
+     */
+    private $yahooUrl;
+
+	/**
+	 * @var array
+	 */
+	private $currencyCodes = array();
+
+
+	/**
+	 * Set the Yahoo! url.
+	 *
+	 * @param string $url
+	 */
+	public function setYahooUrl($url)
+	{
+		$this->yahooUrl = $url;
+	}
+
+	/**
+     * Init object storage
+     */
+    public function attachAll()
+    {
+		foreach ($this->managedCurrencies as $managedCurrency) {
+			$this->addCurrency($managedCurrency);
+		}
+
+		$defaultRate = 1;
+
+		// Add default currency (euro in this example)
+		$euro = new $this->currencyClass;
+		$euro->setCode('EUR');
+		$euro->setRate($defaultRate);
+
+		$this[$euro->getCode()] = $euro;
+
+		// Build YQL query
+		$strCodes = '';
+		foreach ($this->currencyCodes as $index=>$currencyCode) {
+			$strCodes .= "'EUR".$currencyCode."'";
+			if ($index != count($this->currencyCodes) - 1) {
+				$strCodes .= ", ";
+			}
+		}
+
+		$yqlQuery = "select id,Rate from yahoo.finance.xchange where pair in (".$strCodes.")";
+
+		$args = array(
+			'q' => $yqlQuery,
+			'format' => "json",
+			'env' => "store://datatables.org/alltableswithkeys",
+		);
+
+		$yqlQueryURL = $this->yahooUrl
+			. "?q=" . urlencode($yqlQuery)
+			. "&format=json"
+			. "&env=store://datatables.org/alltableswithkeys";
+
+		$ch = curl_init();
+		curl_setopt($ch, CURLOPT_URL, $yqlQueryURL);
+		curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
+		$json = curl_exec($ch);
+
+		// Convert JSON response to PHP object
+		$data = json_decode($json);
+		$results = $data->query->results->rate;
+
+		// Check if query was okay and result is given
+		if (is_null($results)) {
+			new \RuntimeException('YQL query failed!');
+		}
+
+		$currencies = array();
+
+		foreach ($results as $row) {
+			$code = substr($row->id, 3);
+			$rate = $row->Rate;
+
+			$currencies[$code] = $rate;
+		}
+
+        foreach ($currencies as $code => $rate) {
+			if (in_array($code, $this->managedCurrencies)) { // you can check if the currency is in the managed currencies
+				$currency = new $this->currencyClass;
+				$currency->setCode($code);
+				$currency->setRate($rate);
+
+                $this[$currency->getCode()] = $currency;
+            }
+		}
+
+        // get the default rate from the default currency defined in the configuration
+        if (isset($this[$this->defaultCurrency])) {
+			$defaultRate = $this[$this->defaultCurrency]->getRate();
+		}
+
+        // convert rates according to the default one.
+        $this->convertAll($defaultRate);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getIdentifier()
+    {
+        return 'yahoo';
+    }
+
+	/**
+	 * Add currency to the query
+	 *
+	 * @param $code
+	 */
+	private function addCurrency($code) {
+		$this->currencyCodes[] = $code;
+	}
+
+}

Adapter/AdapterFactory.php

@@ -73,6 +73,12 @@ public function getConfigTreeBuilder()
                 ->scalarNode('oer_app_id')
                     ->defaultValue(null)
                 ->end()
+
+                ->scalarNode('yahoo_url')
+                    ->cannotBeEmpty()
+                    ->defaultValue('https://query.yahooapis.com/v1/public/yql')
+                ->end()
+
             ->end()
         ;
 

Adapter/YahooCurrencyAdapter.php

@@ -30,6 +30,7 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('lexik_currency.ecb_url', $config['ecb_url']);
         $container->setParameter('lexik_currency.oer_url', $config['oer_url']);
         $container->setParameter('lexik_currency.oer_app_id', $config['oer_app_id']);
+        $container->setParameter('lexik_currency.yahoo_url', $config['yahoo_url']);
         $container->setParameter('lexik_currency.decimal_part.precision', $config['decimal_part']['precision']);
         $container->setParameter('lexik_currency.decimal_part.round_mode', $config['decimal_part']['round_mode']);
 

DependencyInjection/Configuration.php

@@ -10,6 +10,7 @@
         <parameter key="lexik_currency.abstract_adapter.class">Lexik\Bundle\CurrencyBundle\Adapter\AbstractCurrencyAdapter</parameter>
         <parameter key="lexik_currency.ecb_adapter.class">Lexik\Bundle\CurrencyBundle\Adapter\EcbCurrencyAdapter</parameter>
         <parameter key="lexik_currency.oer_adapter.class">Lexik\Bundle\CurrencyBundle\Adapter\OerCurrencyAdapter</parameter>
+        <parameter key="lexik_currency.yahoo_adapter.class">Lexik\Bundle\CurrencyBundle\Adapter\YahooCurrencyAdapter</parameter>
         <parameter key="lexik_currency.doctrine_adapter.class">Lexik\Bundle\CurrencyBundle\Adapter\DoctrineCurrencyAdapter</parameter>
         <parameter key="lexik_currency.doctrine.orm.entity_manager">default</parameter>
     </parameters>
@@ -54,6 +55,14 @@
             </call>
             <tag name="lexik_currency.adapter" alias="oer_currency_adapter" />
         </service>
+
+        <service id="lexik_currency.yahoo_adapter" class="%lexik_currency.yahoo_adapter.class%" parent="lexik_currency.abstract_adapter">
+            <factory service="lexik_currency.adapter_factory" method="createYahooAdapter" />
+            <call method="setYahooUrl">
+                <argument>%lexik_currency.yahoo_url%</argument>
+            </call>
+            <tag name="lexik_currency.adapter" alias="yahoo_currency_adapter" />
+        </service>
     </services>
 
 </container>

DependencyInjection/LexikCurrencyExtension.php

@@ -29,6 +29,17 @@ public function testCreateEcbAdapter()
         $this->assertEquals(0, count($adapter));
     }
 
+    public function testCreateYahooAdapter()
+    {
+        $factory = new AdapterFactory($this->doctrine, 'EUR', array('EUR', 'USD'), self::CURRENCY_ENTITY);
+        $adapter = $factory->createYahooAdapter();
+
+        $this->assertInstanceOf('Lexik\Bundle\CurrencyBundle\Adapter\YahooCurrencyAdapter', $adapter);
+        $this->assertEquals('EUR', $adapter->getDefaultCurrency());
+        $this->assertEquals(array('EUR', 'USD'), $adapter->getManagedCurrencies());
+        $this->assertEquals(0, count($adapter));
+    }
+
     public function testCreateDoctrineAdapter()
     {
         $em = $this->getEntityManager();