danconia 0.2.8 → 0.4.0

data/lib/danconia/money.rb

@@ -1,16 +1,19 @@
 require 'bigdecimal'
 require 'danconia/errors/exchange_rate_not_found'
+require 'danconia/serializable'
 
 module Danconia
   class Money
     include Comparable
-    attr_reader :amount, :currency, :decimals, :exchange
+    include Serializable
 
-    def initialize amount, currency_code = nil, decimals: 2, exchange: Danconia.config.default_exchange
-      @decimals = decimals
+    attr_reader :amount, :currency, :decimals
+
+    def initialize(amount, currency_code = nil, decimals: 2, exchange_opts: {})
       @amount = parse amount
-      @currency = Currency.find(currency_code || Danconia.config.default_currency, exchange)
-      @exchange = exchange
+      @decimals = decimals
+      @currency = Currency.find(currency_code || Danconia.config.default_currency)
+      @exchange_opts = exchange_opts.reverse_merge(exchange: Danconia.config.default_exchange)
     end
 
     def format decimals: @decimals, **other_options
@@ -41,23 +44,22 @@ module Danconia
     end
 
     def <=> other
-      other = other.exchange_to(currency).amount if other.is_a? Money
-      amount <=> other
+      amount <=> amount_exchanged_to_this_currency(other)
     end
 
-    def exchange_to other_currency, exchange: @exchange
-      other_currency = other_currency.presence && Currency.find(other_currency, exchange) || currency
-      rate = exchange.rate currency.code, other_currency.code
-      clone_with amount * rate, other_currency, exchange
+    def exchange_to other_currency, **opts
+      opts = @exchange_opts.merge(opts)
+      other_currency = other_currency.presence && Currency.find(other_currency) || currency
+      rate = opts[:exchange].rate currency.code, other_currency.code, opts.except(:exchange)
+      clone_with amount * rate, other_currency, opts
     end
 
-    %w(+ - * /).each do |op|
-      class_eval <<-EOR, __FILE__, __LINE__ + 1
+    %w[+ - * /].each do |op|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{op} other
-          other = other.exchange_to(currency, exchange: @exchange).amount if other.is_a? Money
-          clone_with(amount #{op} other)
+          clone_with(amount #{op} amount_exchanged_to_this_currency(other))
         end
-      EOR
+      RUBY
     end
 
     def round *args
@@ -68,10 +70,6 @@ module Danconia
       (self * 100).round
     end
 
-    def as_json *args
-      amount.as_json *args
-    end
-
     def default_currency?
       currency.code == Danconia.config.default_currency
     end
@@ -84,8 +82,8 @@ module Danconia
       end
     end
 
-    def respond_to? method, *args
-      super or @amount.respond_to?(method, *args)
+    def respond_to_missing? method, *args
+      @amount.respond_to?(method, *args) || super
     end
 
     private
@@ -94,8 +92,16 @@ module Danconia
       BigDecimal(object.to_s) rescue BigDecimal(0)
     end
 
-    def clone_with amount, currency = @currency, exchange = @exchange
-      Money.new amount, currency, decimals: decimals, exchange: exchange
+    def clone_with amount, currency = @currency, exchange_opts = @exchange_opts
+      Money.new amount, currency, decimals: @decimals, exchange_opts: exchange_opts
+    end
+
+    def amount_exchanged_to_this_currency other
+      if other.is_a? Money
+        other.exchange_to(currency, @exchange_opts).amount
+      else
+        other
+      end
     end
   end
 end

data/lib/danconia/pair.rb

@@ -0,0 +1,15 @@
+module Danconia
+  Pair = Struct.new(:from, :to) do
+    def self.parse str
+      new str[0..2], str[3..-1]
+    end
+
+    def invert
+      Pair.new to, from
+    end
+
+    def to_s
+      [from, to].join
+    end
+  end
+end

data/lib/danconia/serializable.rb

@@ -0,0 +1,17 @@
+module Danconia
+  module Serializable
+    def marshal_dump
+      {amount: @amount, currency: @currency.code, decimals: @decimals}
+    end
+
+    def marshal_load serialized_money
+      @amount = serialized_money[:amount]
+      @currency = Currency.find(serialized_money[:currency])
+      @decimals = serialized_money[:decimals]
+    end
+
+    def as_json _options = {}
+      {amount: @amount, currency: @currency.code}
+    end
+  end
+end

data/lib/danconia/stores/active_record.rb

@@ -1,20 +1,43 @@
 module Danconia
   module Stores
+    # Store implementation that persist rates using ActiveRecord.
     class ActiveRecord
+      # @param unique_keys [Array] each save_rates will update records with this keys' values
+      # @param date_field [Symbol] used when storing daily rates
+      def initialize unique_keys: %i[pair], date_field: nil
+        @unique_keys = unique_keys
+        @date_field = date_field
+      end
+
+      # Creates or updates the rates by the `unique_keys` provided in the constructor.
+      #
+      # @param rates [Array] must be an array of maps.
       def save_rates rates
         ExchangeRate.transaction do
-          rates.each do |pair, rate|
-            ExchangeRate.where(pair: pair).first_or_initialize.update rate: rate
+          rates.each do |fields|
+            ExchangeRate
+              .where(fields.slice(*@unique_keys))
+              .first_or_initialize
+              .update(fields.slice(*ExchangeRate.column_names.map(&:to_sym)))
           end
         end
       end
 
-      def direct_rate from, to
-        ExchangeRate.find_by(pair: [from, to].join)&.rate
+      # Returns an array of maps like the one it received.
+      def rates **filters
+        ExchangeRate.where(process_filters(filters)).map { |er| er.attributes.symbolize_keys }
       end
 
-      def rates
-        Hash[ExchangeRate.all.map { |er| [er.pair, er.rate] }]
+      private
+
+      def process_filters filters
+        if @date_field
+          param = filters.delete(@date_field) || Date.today
+          last_record = ExchangeRate.where(filters).where("#{@date_field} <= ?", param).order(@date_field => :desc).first
+          filters.merge(@date_field => (last_record[@date_field] if last_record))
+        else
+          filters
+        end
       end
     end
 

data/lib/danconia/stores/in_memory.rb

@@ -1,19 +1,14 @@
 module Danconia
   module Stores
     class InMemory
-      attr_reader :rates
-
-      def initialize rates: {}
-        save_rates rates
-      end
-
-      # @rates should be of a map of pair->rate like {'USDEUR' => 1.25}
       def save_rates rates
         @rates = rates
       end
 
-      def direct_rate from, to
-        @rates[[from, to].join]
+      def rates **filters
+        @rates.select do |r|
+          filters.all? { |k, v| r[k] == v }
+        end
       end
     end
   end

data/lib/danconia/version.rb

@@ -1,3 +1,3 @@
 module Danconia
-  VERSION = '0.2.8'
+  VERSION = '0.4.0'
 end

data/lib/danconia.rb

@@ -1,11 +1,14 @@
+require 'date'
+
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/reverse_merge'
+
 require 'danconia/version'
 require 'danconia/config'
 require 'danconia/currency'
 require 'danconia/money'
 require 'danconia/kernel'
-require 'danconia/integrations/active_record'
-require 'danconia/exchanges/exchange'
+require 'danconia/exchange'
 require 'danconia/exchanges/fixed_rates'
-require 'danconia/exchanges/currency_layer'
 require 'danconia/stores/in_memory'
-require 'danconia/stores/active_record'

data/shell.nix

@@ -0,0 +1,10 @@
+with import <nixpkgs> {};
+mkShell {
+  nativeBuildInputs = [
+    ruby
+    sqlite
+  ];
+  shellHook = ''
+    gem list -i '^bundler$' -v 1.17.3 >/dev/null || gem install bundler --version=1.17.3 --no-document
+  '';
+}

data/spec/danconia/exchanges/bna_spec.rb

@@ -0,0 +1,52 @@
+require 'danconia/exchanges/bna'
+
+module Danconia
+  module Exchanges
+    describe BNA do
+      subject { BNA.new }
+
+      context 'fetch_rates' do
+        it 'extracts the rates from the html' do
+          stub_request(:get, 'https://www.bna.com.ar/Personas').to_return body: fixture('home.html')
+          rates = subject.fetch_rates
+
+          expect(rates.select { |r| r[:rate_type] == 'billetes' }).to eq [
+            {pair: 'USDARS', rate: 78.25, date: Date.new(2020, 9, 1), rate_type: 'billetes'},
+            {pair: 'EURARS', rate: 89, date: Date.new(2020, 9, 1), rate_type: 'billetes'},
+            {pair: 'BRLARS', rate: 14.5, date: Date.new(2020, 9, 1), rate_type: 'billetes'}
+          ]
+
+          expect(rates.select { |r| r[:rate_type] == 'divisas' }).to eq [
+            {pair: 'USDARS', rate: 74.18, date: Date.new(2020, 8, 31), rate_type: 'divisas'},
+            {pair: 'EURARS', rate: 88.6822, date: Date.new(2020, 8, 31), rate_type: 'divisas'}
+          ]
+        end
+
+        it 'raise error if cannot parse the document' do
+          stub_request(:get, 'https://www.bna.com.ar/Personas').to_return body: 'some invalid html'
+          expect { subject.fetch_rates }.to raise_error Errors::APIError
+        end
+
+        def fixture file
+          File.read("#{__dir__}/fixtures/bna/#{file}")
+        end
+      end
+
+      context 'rates' do
+        it 'pass the params to the store and converts the array of rates back to hash' do
+          store = double('store')
+          expect(store).to receive(:rates)
+            .with(rate_type: 'billetes', date: nil)
+            .and_return([{pair: 'USDARS', rate: 3}])
+
+          exchange = BNA.new(store: store)
+          expect(exchange.rates(rate_type: 'billetes')).to eq 'USDARS' => 3
+        end
+
+        it 'rate_type is required' do
+          expect { BNA.new.rates }.to raise_error ArgumentError
+        end
+      end
+    end
+  end
+end

data/spec/danconia/exchanges/currency_layer_spec.rb

@@ -1,55 +1,50 @@
-require 'spec_helper'
+require 'danconia/exchanges/currency_layer'
 
 module Danconia
   module Exchanges
     describe CurrencyLayer do
-      subject { CurrencyLayer.new access_key: '[KEY]' }
-
       context 'fetch_rates' do
+        subject { CurrencyLayer.new access_key: '[KEY]' }
+
         it 'uses the API to retrive the rates' do
-          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: <<~END
-            {
-                "success": true,
-                "source": "USD",
-                "quotes": {
-                    "USDARS": 27.110001,
-                    "USDAUD": 1.346196
-                }
-            }
-          END
+          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]')
+            .to_return(body: fixture('success.json'))
+
           expect(subject.fetch_rates).to eq 'USDARS' => 27.110001, 'USDAUD' => 1.346196
         end
 
         it 'when the API returns an error' do
-          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: <<~END
-            {
-                "success": false,
-                "error": {
-                  "code": 104,
-                  "info": "Your monthly usage limit has been reached. Please upgrade your subscription plan."
-                }
-            }
-          END
+          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]')
+            .to_return(body: fixture('failure.json'))
+
           expect { subject.fetch_rates }.to raise_error Errors::APIError
         end
+
+        def fixture file
+          File.read("#{__dir__}/fixtures/currency_layer/#{file}")
+        end
       end
 
       context 'update_rates!' do
         it 'fetches the rates and stores them' do
-          expect(subject).to receive(:fetch_rates) { {'USDARS' => 3, 'USDAUD' => 4} }
-          subject.update_rates!
-          expect(subject.rates.size).to eq 2
-          expect(subject.rate('USD', 'ARS')).to eq 3
-          expect(subject.rate('USD', 'AUD')).to eq 4
+          store = double('store')
+          expect(store).to receive(:save_rates).with([{pair: 'USDARS', rate: 3}, {pair: 'USDAUD', rate: 4}])
+
+          exchange = CurrencyLayer.new(access_key: '...', store: store)
+          allow(exchange).to receive(:fetch_rates).and_return('USDARS' => 3, 'USDAUD' => 4)
+          exchange.update_rates!
         end
+      end
+
+      context 'rates' do
+        it 'converts the array from the store back to a map of pair to rates' do
+          store = double('store')
+          expect(store).to receive(:rates).and_return([{pair: 'USDARS', rate: 3}, {pair: 'USDAUD', rate: 4}])
 
-        it 'if a rate already exists should update it' do
-          subject.store.save_rates 'USDARS' => 3
-          expect(subject).to receive(:fetch_rates) { {'USDARS' => 3.1} }
-          subject.update_rates!
-          expect(subject.rate('USD', 'ARS')).to eq 3.1
+          exchange = CurrencyLayer.new(access_key: '...', store: store)
+          expect(exchange.rates).to eq 'USDARS' => 3, 'USDAUD' => 4
         end
       end
     end
   end
-end
+end

data/spec/danconia/exchanges/exchange_spec.rb

@@ -0,0 +1,54 @@
+module Danconia
+  module Exchanges
+    describe Exchange do
+      context 'rate' do
+        it 'returns the exchange rate value for the supplied currencies' do
+          exchange = fake_exchange('USDEUR' => 3, 'USDARS' => 4)
+          expect(exchange.rate('USD', 'EUR')).to eq 3
+          expect(exchange.rate('USD', 'ARS')).to eq 4
+        end
+
+        it 'if the direct conversion is not found, tries to find the inverse' do
+          exchange = fake_exchange('USDEUR' => 3)
+          expect(exchange.rate('EUR', 'USD')).to be_within(0.00001).of(1.0 / 3)
+        end
+
+        it 'if not direct nor inverse conversion is found, tries to convert through USD' do
+          exchange = fake_exchange('USDEUR' => 3, 'USDARS' => 6)
+          expect(exchange.rate('EUR', 'ARS')).to be_within(0.00001).of 2
+          expect(exchange.rate('ARS', 'EUR')).to be_within(0.00001).of 0.5
+        end
+
+        it 'pairs can have a different common currency' do
+          exchange = fake_exchange('EURARS' => 3, 'BRLARS' => 1.5)
+          expect(exchange.rate('EUR', 'ARS')).to eq 3
+          expect(exchange.rate('ARS', 'EUR')).to be_within(0.00001).of(1.0 / 3)
+          expect(exchange.rate('BRL', 'ARS')).to eq 1.5
+          expect(exchange.rate('EUR', 'BRL')).to eq 3 / 1.5
+        end
+
+        it 'raises an error if the conversion cannot be made' do
+          expect { fake_exchange({}).rate('USD', 'EUR') }.to raise_error Errors::ExchangeRateNotFound
+        end
+
+        it 'should allow to pass options to filter the rates' do
+          exchange = Class.new(Exchange) do
+            def rates type:
+              case type
+              when 'divisa' then {'USDARS' => 7}
+              when 'billete' then {'USDARS' => 8}
+              end
+            end
+          end.new
+
+          expect(exchange.rate('USD', 'ARS', type: 'divisa')).to eq 7
+          expect(exchange.rate('USD', 'ARS', type: 'billete')).to eq 8
+        end
+
+        def fake_exchange(rates)
+          FixedRates.new(rates: rates)
+        end
+      end
+    end
+  end
+end

data/spec/danconia/exchanges/fixtures/bna/home.html

@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html lang="es" class="pc">
+
+<body>
+  <div id="rightHome">
+    <div class="col-md-3">
+      <div class="tabSmall">
+        <ul class="nav nav-tabs">
+
+          <li class="active"><a href="#billetes" data-toggle="tab">Cotización Billetes</a>
+            <div class="arrow"></div>
+          </li>
+          <li><a href="#divisas" data-toggle="tab">Cotización Divisas</a>
+            <div class="arrow"></div>
+          </li>
+        </ul>
+
+        <div class="tab-content">
+
+          <div class="tab-pane fade in active" id="billetes">
+
+            <table class="table cotizacion">
+              <thead>
+                <tr>
+                  <th class="fechaCot">1/9/2020</th>
+                  <th>Compra</th>
+                  <th>Venta</th>
+                </tr>
+              </thead>
+              <tbody>
+
+                <tr>
+                  <td class="tit">Dolar U.S.A</td>
+                  <td>73,2500</td>
+                  <td>78,2500</td>
+                </tr>
+                <tr>
+                  <td class="tit">Euro</td>
+                  <td>84,0000</td>
+                  <td>89,0000</td>
+                </tr>
+                <tr>
+                  <td class="tit">Real *</td>
+                  <td>1250,0000</td>
+                  <td>1450,0000</td>
+                </tr>
+
+              </tbody>
+            </table>
+            <a href="#" class="link-cotizacion" data-toggle="modal" data-target="#modalHistorico" id="buttonHistoricoBilletes">Ver histórico</a>
+            <div class="legal">Hora Actualización: 10:40</div>
+            <div class="legal">(*) cotización cada 100 unidades.</div>
+
+          </div>
+
+          <div class="tab-pane fade" id="divisas">
+            <table class="table cotizacion">
+              <thead>
+                <tr>
+                  <th class="fechaCot">31/8/2020</th>
+                  <th>Compra</th>
+                  <th>Venta</th>
+                </tr>
+              </thead>
+              <tbody>
+
+                <tr>
+                  <td class="tit">Dolar U.S.A</td>
+                  <td>73.9800</td>
+                  <td>74.1800</td>
+                </tr>
+                <tr>
+                  <td class="tit">Libra Esterlina</td>
+                  <td>98.8743</td>
+                  <td>99.3641</td>
+                </tr>
+                <tr>
+                  <td class="tit">Euro</td>
+                  <td>88.2581</td>
+                  <td>88.6822</td>
+                </tr>
+                <tr>
+                  <td class="tit">Franco Suizos *</td>
+                  <td>8188.4905</td>
+                  <td>8221.8519</td>
+                </tr>
+                <tr>
+                  <td class="tit">YENES *</td>
+                  <td>69.8238</td>
+                  <td>70.1124</td>
+                </tr>
+                <tr>
+                  <td class="tit">Dolares Canadienses *</td>
+                  <td>5675.3160</td>
+                  <td>5698.6457</td>
+                </tr>
+                <tr>
+                  <td class="tit">Coronas Danesas *</td>
+                  <td>1184.4394</td>
+                  <td>1195.0806</td>
+                </tr>
+                <tr>
+                  <td class="tit">Coronas Noruegas *</td>
+                  <td>845.1963</td>
+                  <td>854.8381</td>
+                </tr>
+                <tr>
+                  <td class="tit">Coronas Suecas *</td>
+                  <td>853.8596</td>
+                  <td>863.8369</td>
+                </tr>
+
+              </tbody>
+            </table>
+            <a href="#" class="link-cotizacion" data-toggle="modal" data-target="#modalHistorico" id="buttonHistoricoMonedas">Ver histórico</a>
+            <div class="legal">(*) cotización cada 100 unidades.</div>
+            <div class="legal leyenda">El tipo de cambio de cierre de divisa es suministrado al público a fines informativos, como referencia de la cotización de la divisa en el mercado mayorista al final de cada día.</div>
+          </div>
+        </div>
+      </div>
+    </div>
+</body>
+
+</html>

data/spec/danconia/exchanges/fixtures/currency_layer/failure.json

@@ -0,0 +1,7 @@
+{
+  "success": false,
+  "error": {
+    "code": 104,
+    "info": "Your monthly usage limit has been reached. Please upgrade your subscription plan."
+  }
+}

data/spec/danconia/exchanges/fixtures/currency_layer/success.json

@@ -0,0 +1,8 @@
+{
+  "success": true,
+  "source": "USD",
+  "quotes": {
+    "USDARS": 27.110001,
+    "USDAUD": 1.346196
+  }
+}

data/spec/danconia/integrations/active_record_spec.rb

@@ -1,12 +1,10 @@
-require 'spec_helper'
-
 module Danconia
   describe Integrations::ActiveRecord, active_record: true do
     context 'single currency' do
       it 'setter' do
-        expect(Product.new(price: 1.536).read_attribute :price).to eq 1.54
-        expect(Product.new(price: nil).read_attribute :price).to eq nil
-        expect(Product.new(price: Money(3)).read_attribute :price).to eq 3
+        expect(Product.new(price: 1.536).read_attribute(:price)).to eq 1.54
+        expect(Product.new(price: nil).read_attribute(:price)).to eq nil
+        expect(Product.new(price: Money(3)).read_attribute(:price)).to eq 3
       end
 
       it 'getter' do
@@ -34,6 +32,28 @@ module Danconia
       end
     end
 
+    context 'exchange options support' do
+      let(:exchange) do
+        Class.new(Exchange) do
+          def rates rate_type:
+            case rate_type
+            when 'divisa' then {'USDARS' => 7}
+            when 'billete' then {'USDARS' => 8}
+            end
+          end
+        end.new
+      end
+
+      it 'allows to specify options that will be pass to the exchange when exchanging to other currencies' do
+        klass = Class.new(ActiveRecord::Base) do
+          self.table_name = 'products'
+          money :price, rate_type: 'divisa'
+        end
+
+        expect(klass.new(price: Money(10, 'USD')).price.exchange_to('ARS', exchange: exchange)).to eq Money(70, 'ARS')
+      end
+    end
+
     class Product < ActiveRecord::Base
       money :price, :tax, :discount, :cost
     end