Merge pull request #1951 from BoGnY/feature/cer-provider

Implemented multiple Currency Exchange Rates sites engine

.env.docker

@@ -93,8 +93,14 @@ SEND_REPORT_JOURNALS=${SEND_REPORT_JOURNALS}
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
 MAPBOX_API_KEY=${MAPBOX_API_KEY}
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+# Firefly III currently supports two provider for live Currency Exchange Rates:
+# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
+# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
+# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
+CER_PROVIDER=${CER_PROVIDER}
+# If you have select "fixer" as default currency exchange rates,
+# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
 # the free API up to the point where you might as well offer nothing.
 FIXER_API_KEY=${FIXER_API_KEY}
 

.env.example

@@ -93,8 +93,14 @@ SEND_REPORT_JOURNALS=true
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
 MAPBOX_API_KEY=
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+# Firefly III currently supports two provider for live Currency Exchange Rates:
+# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
+# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
+# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
+CER_PROVIDER=fixer
+# If you have select "fixer" as default currency exchange rates,
+# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
 # the free API up to the point where you might as well offer nothing.
 FIXER_API_KEY=
 

.env.heroku

@@ -93,8 +93,14 @@ SEND_REPORT_JOURNALS=true
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
 MAPBOX_API_KEY=
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+# Firefly III currently supports two provider for live Currency Exchange Rates:
+# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
+# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
+# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
+CER_PROVIDER=fixer
+# If you have select "fixer" as default currency exchange rates,
+# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
 # the free API up to the point where you might as well offer nothing.
 FIXER_API_KEY=
 

.env.sandstorm

@@ -93,8 +93,14 @@ SEND_REPORT_JOURNALS=true
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
 MAPBOX_API_KEY=
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+# Firefly III currently supports two provider for live Currency Exchange Rates:
+# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
+# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
+# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
+CER_PROVIDER=fixer
+# If you have select "fixer" as default currency exchange rates,
+# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
 # the free API up to the point where you might as well offer nothing.
 FIXER_API_KEY=
 

.env.testing

@@ -93,8 +93,14 @@ SEND_REPORT_JOURNALS=true
 # Set a Mapbox API key here (see mapbox.com) so there might be a map available at various places.
 MAPBOX_API_KEY=
 
-# Set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
-# Please note that this will only work for paid fixer.io accounts because they severly limited
+# Firefly III currently supports two provider for live Currency Exchange Rates:
+# "fixer" is the default (for backward compatibility), and "ratesapi" is the new one.
+# RatesApi.IO (see https://ratesapi.io) is a FREE and OPEN SOURCE live currency exchange rates,
+# built compatible with Fixer.IO, based on data published by European Central Bank, and don't require API key.
+CER_PROVIDER=fixer
+# If you have select "fixer" as default currency exchange rates,
+# set a Fixer IO API key here (see https://fixer.io) to enable live currency exchange rates.
+# Please note that this WILL ONLY WORK FOR PAID fixer.io accounts because they severely limited
 # the free API up to the point where you might as well offer nothing.
 FIXER_API_KEY=
 

app/Providers/FireflyServiceProvider.php

@@ -185,7 +185,11 @@ class FireflyServiceProvider extends ServiceProvider
         $this->app->bind(FiscalHelperInterface::class, FiscalHelper::class);
         $this->app->bind(BalanceReportHelperInterface::class, BalanceReportHelper::class);
         $this->app->bind(BudgetReportHelperInterface::class, BudgetReportHelper::class);
-        $this->app->bind(ExchangeRateInterface::class, FixerIOv2::class);
+        $class = (string)config(sprintf('firefly.cer_providers.%s', (string)config('firefly.cer_provider')));
+        if('' === $class) {
+            throw new FireflyException('Invalid currency exchange rate provider. Cannot continue.');
+        }
+        $this->app->bind(ExchangeRateInterface::class, $class);
 
         // password verifier thing
         $this->app->bind(Verifier::class, PwndVerifierV2::class);

app/Services/Currency/RatesApiIOv1.php

@@ -0,0 +1,125 @@
+<?php
+/**
+ * RatesApiIOv1.php
+ * Copyright (c) 2018 thegrumpydictator@gmail.com
+ *
+ * This file is part of Firefly III.
+ *
+ * Firefly III is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Firefly III is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
+ */
+declare(strict_types=1);
+
+namespace FireflyIII\Services\Currency;
+
+use Carbon\Carbon;
+use Exception;
+use FireflyIII\Models\CurrencyExchangeRate;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\User;
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\GuzzleException;
+use Log;
+
+/**
+ * Class RatesApiIOv1.
+ */
+class RatesApiIOv1 implements ExchangeRateInterface
+{
+    /** @var User */
+    protected $user;
+
+    /**
+     * Constructor.
+     */
+    public function __construct()
+    {
+        if ('testing' === config('app.env')) {
+            Log::warning(sprintf('%s should not be instantiated in the TEST environment!', \get_class($this)));
+        }
+    }
+
+    /**
+     * @param TransactionCurrency $fromCurrency
+     * @param TransactionCurrency $toCurrency
+     * @param Carbon              $date
+     *
+     * @return CurrencyExchangeRate
+     */
+    public function getRate(TransactionCurrency $fromCurrency, TransactionCurrency $toCurrency, Carbon $date): CurrencyExchangeRate
+    {
+        // create new exchange rate with default values.
+        $rate         = 0;
+        $exchangeRate = new CurrencyExchangeRate;
+        $exchangeRate->user()->associate($this->user);
+        $exchangeRate->fromCurrency()->associate($fromCurrency);
+        $exchangeRate->toCurrency()->associate($toCurrency);
+        $exchangeRate->date       = $date;
+        $exchangeRate->rate       = $rate;
+        $exchangeRate->updated_at = new Carbon;
+        $exchangeRate->created_at = new Carbon;
+
+        // build URI
+        $uri = sprintf(
+            'https://ratesapi.io/api/%s?base=%s&symbols=%s',
+            $date->format('Y-m-d'), $fromCurrency->code, $toCurrency->code
+        );
+        Log::debug(sprintf('Going to request exchange rate using URI %s', $uri));
+        $client = new Client;
+        try {
+            $res        = $client->request('GET', $uri);
+            $statusCode = $res->getStatusCode();
+            $body       = $res->getBody()->getContents();
+        } catch (GuzzleException|Exception $e) {
+            // don't care about error
+            $body       = sprintf('Guzzle exception: %s', $e->getMessage());
+            $statusCode = 500;
+        }
+        Log::debug(sprintf('Result status code is %d', $statusCode));
+        Log::debug(sprintf('Result body is: %s', $body));
+
+        $content = null;
+        if (200 !== $statusCode) {
+            Log::error(sprintf('Something went wrong. Received error code %d and body "%s" from RatesApiIO.', $statusCode, $body));
+        }
+        $success = false;
+        // get rate from body:
+        if (200 === $statusCode) {
+            $content = json_decode($body, true);
+            $success = true;
+        }
+        if (null !== $content && true === $success) {
+            $code = $toCurrency->code;
+            $rate = (float)($content['rates'][$code] ?? 0);
+            Log::debug('Got the following rates from RatesApi: ', $content['rates'] ?? []);
+        }
+
+        $exchangeRate->rate = $rate;
+        if (0.0 !== $rate) {
+            Log::debug('Rate is not zero, save it!');
+            $exchangeRate->save();
+        }
+
+        return $exchangeRate;
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return mixed|void
+     */
+    public function setUser(User $user)
+    {
+        $this->user = $user;
+    }
+}

config/firefly.php

@@ -24,6 +24,8 @@
 declare(strict_types=1);
 
 use FireflyIII\Export\Exporter\CsvExporter;
+use FireflyIII\Services\Currency\FixerIOv2;
+use FireflyIII\Services\Currency\RatesApiIOv1;
 use FireflyIII\TransactionRules\Actions\AddTag;
 use FireflyIII\TransactionRules\Actions\AppendDescription;
 use FireflyIII\TransactionRules\Actions\AppendNotes;
@@ -111,6 +113,7 @@ return [
     'analytics_id'                 => env('ANALYTICS_ID', ''),
     'disable_frame_header'         => env('DISABLE_FRAME_HEADER', false),
     'login_provider'               => envNonEmpty('LOGIN_PROVIDER', 'eloquent'),
+    'cer_provider'                 => envNonEmpty('CER_PROVIDER', 'fixer'),
     'allowedMimes'                 => [
         /* plain files */
         'text/plain',
@@ -479,4 +482,8 @@ return [
     'search_modifiers' => ['amount_is', 'amount', 'amount_max', 'amount_min', 'amount_less', 'amount_more', 'source', 'destination', 'category',
                            'budget', 'bill', 'type', 'date', 'date_before', 'date_after', 'on', 'before', 'after'],
     // tag notes has_attachments
+    'cer_providers'    => [
+        'fixer'    => FixerIOv2::class,
+        'ratesapi' => RatesApiIOv1::class,
+    ],
 ];