danconia 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f379e57876333600210d3f3669e1a45654b8016238abd82df38eaf6674084c5c
-  data.tar.gz: b85beca8d071d199c13771c14916efc26aac999df2d0dc7bb167597fb5822f29
+  metadata.gz: 38d88815b5c3c9155db3c64433d6469614656a2464ab6a0c0eae51b3429b084d
+  data.tar.gz: d8962d50c98a68e8acfbc2a1424e81b77b1d506d069d4e87c0fa32803482d2b0
 SHA512:
-  metadata.gz: 5712b367efd1638949888f2e1fe254a174cd63c23d7e4d14ee8f9601380f4b0cf376b572642fad40d93b4d1d7b8333de2788eff5042fe29e79c36bb9d444315a
-  data.tar.gz: b55eab153bed5d5572789b7ed4b7a3cbb6ef8907269a5babfdebe12c1947152baac4c5bde5fc0b4bada904323c6524ceafe0d7991aa64262123362ee22209764
+  metadata.gz: 69fa03e8ae6c01a37eaafaf9fe358b1e57eca34bd4e1113fb795002b80d4f5dc2a3934c06f1b3102a3c64e3403e16f3d6fd97c9f301b819f9de6b742c3ea088d
+  data.tar.gz: 4881c55540c4b0e51e6018a23aae7923effc31ea9694295aae07a08a62fa60b32d6943adea8bd3798d5349b6f15c97ab2948f6410593c6d03ceb35c136e12c9b

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danconia (0.2.1)
+    danconia (0.2.2)
       activerecord (>= 3.0.0)
 
 GEM

data/README.md

@@ -2,6 +2,8 @@
 
 TODO: Write a gem description
 
+[![Build Status](https://travis-ci.org/eeng/danconia.svg?branch=master)](https://travis-ci.org/eeng/danconia)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/examples/currency_layer.rb

@@ -0,0 +1,21 @@
+require 'danconia'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Schema.define do
+  create_table :exchange_rates do |t|
+    t.string :pair, limit: 6
+    t.decimal :rate, precision: 12, scale: 6
+    t.index :pair, unique: true
+  end
+end
+
+Danconia.configure do |config|
+  config.default_exchange = Danconia::Exchanges::CurrencyLayer.new(access_key: ENV['ACCESS_KEY'], store: Danconia::Stores::ActiveRecord.new)
+end
+
+# Periodically do this
+puts 'Updating dates with CurrencyLayer API...'
+Danconia.config.default_exchange.update_rates!
+
+puts Money(1, 'USD').exchange_to('EUR').inspect # => 0.854896 EUR

data/examples/{basic.rb → fixed_rates.rb}

@@ -5,4 +5,4 @@ Danconia.configure do |config|
   config.default_exchange = Danconia::Exchanges::FixedRates.new(rates: {'USDARS' => 27.5, 'USDEUR' => 0.86})
 end
 
-puts Money(10, 'ARS').exchange_to('EUR').inspect
+puts Money(10, 'ARS').exchange_to('EUR').inspect # => 0.31273 EUR

data/lib/danconia.rb

@@ -4,4 +4,8 @@ require 'danconia/currency'
 require 'danconia/money'
 require 'danconia/kernel'
 require 'danconia/integrations/active_record'
+require 'danconia/exchanges/exchange'
 require 'danconia/exchanges/fixed_rates'
+require 'danconia/exchanges/currency_layer'
+require 'danconia/stores/in_memory'
+require 'danconia/stores/active_record'

data/lib/danconia/config.rb

@@ -1,5 +1,3 @@
-require 'danconia/exchange'
-
 module Danconia
   class << self
     def config

data/lib/danconia/currency.rb

@@ -2,7 +2,7 @@ module Danconia
   class Currency < Struct.new(:code, :symbol, :description, keyword_init: true)
     def self.find code, exchange
       return code if code.is_a? Currency
-      new exchange.available_currencies.find { |c| c[:code] == code } || {code: code, symbol: '$'}
+      new exchange.currencies.find { |c| c[:code] == code } || {code: code, symbol: '$'}
     end
   end
 end

data/lib/danconia/exchanges/currency_layer.rb

@@ -5,15 +5,11 @@ require 'json'
 module Danconia
   module Exchanges
     class CurrencyLayer < Exchange
-      def initialize access_key:
-        super()
+      def initialize access_key:, **args
+        super args
         @access_key = access_key
       end
 
-      def update_rates!
-        @store.save_rates fetch_rates
-      end
-
       def fetch_rates
         response = JSON.parse Net::HTTP.get URI "http://www.apilayer.net/api/live?access_key=#{@access_key}"
         if response['success']

data/lib/danconia/exchanges/exchange.rb

@@ -0,0 +1,32 @@
+module Danconia
+  module Exchanges
+    class Exchange
+      attr_reader :store, :currencies
+
+      def initialize store: Stores::InMemory.new, currencies: []
+        @store = store
+        @currencies = currencies
+      end
+
+      def rate from, to
+        if from == 'USD' and direct_rate = @store.direct_rate(from, to)
+          direct_rate
+        elsif to == 'USD' and inverse_rate = @store.direct_rate(to, from)
+          (1.0 / inverse_rate).round 6
+        elsif from != 'USD' and to != 'USD' and from_in_usd = rate(from, 'USD') and to_per_usd = rate('USD', to)
+          (from_in_usd * to_per_usd).round 6
+        else
+          raise Errors::ExchangeRateNotFound.new(from, to)
+        end
+      end
+
+      def rates
+        @store.rates
+      end
+
+      def update_rates!
+        @store.save_rates fetch_rates
+      end
+    end
+  end
+end

data/lib/danconia/exchanges/fixed_rates.rb

@@ -1,9 +1,14 @@
 module Danconia
   module Exchanges
     class FixedRates < Exchange
-      def initialize rates: {}
-        super()
-        @store.save_rates rates
+      def initialize rates: {}, **args
+        super args
+        @rates = rates
+        update_rates!
+      end
+
+      def fetch_rates
+        @rates
       end
     end
   end

data/lib/danconia/money.rb

@@ -8,17 +8,21 @@ module Danconia
 
     def initialize amount, currency_code = nil, decimals: 2, exchange: Danconia.config.default_exchange
       @decimals = decimals
-      @amount = parse(amount)
+      @amount = parse amount
       @currency = Currency.find(currency_code || Danconia.config.default_currency, exchange)
       @exchange = exchange
     end
 
-    def to_s
+    def format decimals: @decimals
       ActiveSupport::NumberHelper.number_to_currency amount, precision: decimals, unit: currency.symbol
     end
 
+    def to_s
+      format
+    end
+
     def inspect
-      "#<#{self.class.name} #{amount} #{currency.code}>"
+      "#{amount} #{currency.code}"
     end
 
     def == other
@@ -43,11 +47,17 @@ module Danconia
     end
 
     def exchange_to other_currency
-      other_currency = Currency.find(other_currency, exchange)
-      rate = exchange_rate(currency, other_currency)
+      other_currency = other_currency.presence && Currency.find(other_currency, exchange) || currency
+      rate = exchange_rate_to(other_currency.code)
       clone_with amount * rate, other_currency
     end
 
+    def exchange_rate_to to
+      from = currency.code
+      return 1 if from == to
+      exchange.rate from, to
+    end
+
     %w(+ - * /).each do |op|
       class_eval <<-EOR, __FILE__, __LINE__ + 1
         def #{op} other
@@ -65,6 +75,10 @@ module Danconia
       (self * 100).round
     end
 
+    def default_currency?
+      currency.code == Danconia.config.default_currency
+    end
+
     def method_missing method, *args
       if @amount.respond_to? method
         @amount.send method, *args
@@ -80,16 +94,11 @@ module Danconia
     private
 
     def parse object
-      BigDecimal(object.to_s) rescue BigDecimal('0')
+      BigDecimal(object.to_s) rescue BigDecimal(0)
     end
 
     def clone_with amount, currency = @currency
       Money.new amount, currency, decimals: decimals, exchange: exchange
     end
-
-    def exchange_rate from, to
-      return 1 if from == to
-      exchange.rate from.code, to.code
-    end
   end
 end

data/lib/danconia/stores/active_record.rb

@@ -0,0 +1,24 @@
+module Danconia
+  module Stores
+    class ActiveRecord
+      def save_rates rates
+        ExchangeRate.transaction do
+          rates.each do |pair, rate|
+            ExchangeRate.where(pair: pair).first_or_initialize.update rate: rate
+          end
+        end
+      end
+
+      def direct_rate from, to
+        ExchangeRate.find_by(pair: [from, to].join)&.rate
+      end
+
+      def rates
+        ExchangeRate.all
+      end
+    end
+
+    class ExchangeRate < ::ActiveRecord::Base
+    end
+  end
+end

data/lib/danconia/test_helpers.rb

@@ -0,0 +1,18 @@
+module Danconia
+  module TestHelpers
+    class << self
+      def with_config &block
+        old_config = Danconia.config.dup
+        Danconia.configure &block
+        Danconia.config = old_config
+      end
+
+      def with_rates rates
+        with_config do |config|
+          config.default_exchange = Exchanges::FixedRates.new rates: rates, currencies: config.default_exchange.currencies
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/danconia/version.rb

@@ -1,3 +1,3 @@
 module Danconia
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/danconia/exchanges/currency_layer_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'danconia/exchanges/currency_layer'
 
 module Danconia
   module Exchanges

data/spec/danconia/money_spec.rb

@@ -9,11 +9,12 @@ module Danconia
       end
 
       it 'non numeric values are treated as zero' do
+        expect(Money(nil)).to eq Money(0)
         expect(Money('a')).to eq Money(0)
       end
 
       it 'should use the default currency if not specified' do
-        with_config do |config|
+        TestHelpers.with_config do |config|
           config.default_currency = 'ARS'
           expect(Money(0).currency.code).to eq 'ARS'
 
@@ -71,9 +72,7 @@ module Danconia
       end
 
       it 'should exchange to the source currency if they differ' do
-        with_config do |config|
-          config.default_exchange = fake_exchange(rate: 4)
-
+        TestHelpers.with_rates 'USDARS' => 4 do |config|
           expect(Money(3, 'ARS') < Money(1, 'USD')).to be true
           expect(Money(4, 'ARS') < Money(1, 'USD')).to be false
         end
@@ -86,12 +85,18 @@ module Danconia
       end
     end
 
+    context 'format' do
+      it 'allow to override the number of decimals' do
+        expect(Money(3.561, decimals: 3).format(decimals: 1)).to eq '$3.6'
+      end
+    end
+
     context 'to_s' do
       it 'should add the currency symbol' do
         expect(Money(3.25).to_s).to eq '$3.25'
 
-        with_config do |config|
-          config.default_exchange = double 'exchange', available_currencies: [{code: 'EUR', symbol: '€'}, {code: 'JPY', symbol: '¥'}]
+        TestHelpers.with_config do |config|
+          config.default_exchange = Exchanges::FixedRates.new currencies: [{code: 'EUR', symbol: '€'}, {code: 'JPY', symbol: '¥'}]
 
           expect(Money(1, 'EUR').to_s).to eq '€1.00'
           expect(Money(1, 'JPY').to_s).to eq '¥1.00'
@@ -103,15 +108,11 @@ module Danconia
         expect(Money(3.256, decimals: 2).to_s).to eq '$3.26'
         expect(Money(3.2517, decimals: 3).to_s).to eq '$3.252'
       end
-
-      it 'nil should be like zero' do
-        expect(Money(nil).to_s).to eq '$0.00'
-      end
     end
 
     context '.inspect' do
       it 'should display the object internals' do
-        expect(Money(10.25, 'ARS', decimals: 3).inspect).to eq '#<Danconia::Money 10.25 ARS>'
+        expect(Money(10.25, 'ARS', decimals: 3).inspect).to eq '10.25 ARS'
       end
     end
 
@@ -121,8 +122,7 @@ module Danconia
       end
 
       it 'should use the default exchange if not set' do
-        with_config do |config|
-          config.default_exchange = Exchanges::FixedRates.new(rates: {'USDEUR' => 3, 'USDARS' => 4})
+        TestHelpers.with_rates 'USDEUR' => 3, 'USDARS' => 4 do
           expect(Money(2, 'USD').exchange_to('EUR')).to eq Money(6, 'EUR')
           expect(Money(2, 'USD').exchange_to('ARS')).to eq Money(8, 'ARS')
         end
@@ -143,6 +143,21 @@ module Danconia
         expect(m2.decimals).to eq 0
         expect(m1).to eq Money(1, 'USD')
       end
+
+      it 'if the destination currency is blank should not do the conversion' do
+        expect(Money(1, 'USD').exchange_to('')).to eq Money(1, 'USD')
+        expect(Money(1, 'ARS').exchange_to('')).to eq Money(1, 'ARS')
+      end
+    end
+
+    context 'default_currency?' do
+      it 'is true if the currency is the configured default' do
+        TestHelpers.with_config do |config|
+          config.default_currency = 'ARS'
+          expect(Money(1, 'ARS')).to be_default_currency
+          expect(Money(1, 'USD')).to_not be_default_currency
+        end
+      end
     end
 
     context 'delegation' do
@@ -153,7 +168,7 @@ module Danconia
     end
 
     def fake_exchange args = {}
-      double 'exchange', args.reverse_merge(rate: nil, available_currencies: [])
+      double 'exchange', args.reverse_merge(rate: nil, currencies: [])
     end
   end
 end

data/spec/danconia/stores/active_record_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module Danconia
+  module Stores
+    describe ActiveRecord, active_record: true do
+      context 'save_rates' do
+        it 'should create or update the rates' do
+          ExchangeRate.create! pair: 'USDEUR', rate: 2
+          expect { subject.save_rates 'USDEUR' => 3, 'USDARS' => 4 }.to change { ExchangeRate.count }.by 1
+          expect(subject.rates.map { |e| [e.pair, e.rate] }).to eq({'USDEUR' => 3, 'USDARS' => 4}.to_a)
+        end
+      end
+
+      context '#direct_rate' do
+        it 'should find the rate for the pair' do
+          ExchangeRate.create! pair: 'USDEUR', rate: 2
+          expect(subject.direct_rate('USD', 'EUR')).to eq 2
+          expect(subject.direct_rate('USD', 'ARS')).to eq nil
+        end
+      end
+
+      before do
+        ::ActiveRecord::Schema.define do
+          create_table :exchange_rates do |t|
+            t.string :pair, limit: 6
+            t.decimal :rate, precision: 12, scale: 6
+            t.index :pair, unique: true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 require 'danconia'
+require 'danconia/test_helpers'
 require 'webmock/rspec'
 
 Dir["#{__dir__}/support/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
   config.filter_run_when_matching :focus
-  config.include Helpers
   config.include DatabaseCleaner
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danconia
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Emmanuel Nicolau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -125,27 +126,30 @@ files:
 - README.md
 - Rakefile
 - danconia.gemspec
-- examples/basic.rb
+- examples/currency_layer.rb
+- examples/fixed_rates.rb
 - lib/danconia.rb
 - lib/danconia/config.rb
 - lib/danconia/currency.rb
 - lib/danconia/errors/api_error.rb
 - lib/danconia/errors/exchange_rate_not_found.rb
-- lib/danconia/exchange.rb
 - lib/danconia/exchanges/currency_layer.rb
+- lib/danconia/exchanges/exchange.rb
 - lib/danconia/exchanges/fixed_rates.rb
 - lib/danconia/integrations/active_record.rb
 - lib/danconia/kernel.rb
 - lib/danconia/money.rb
+- lib/danconia/stores/active_record.rb
 - lib/danconia/stores/in_memory.rb
+- lib/danconia/test_helpers.rb
 - lib/danconia/version.rb
 - spec/danconia/exchanges/currency_layer_spec.rb
 - spec/danconia/exchanges/fixed_rates_spec.rb
 - spec/danconia/integrations/active_record_spec.rb
 - spec/danconia/money_spec.rb
+- spec/danconia/stores/active_record_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
-- spec/support/helpers.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -174,6 +178,6 @@ test_files:
 - spec/danconia/exchanges/fixed_rates_spec.rb
 - spec/danconia/integrations/active_record_spec.rb
 - spec/danconia/money_spec.rb
+- spec/danconia/stores/active_record_spec.rb
 - spec/spec_helper.rb
 - spec/support/database.rb
-- spec/support/helpers.rb

data/lib/danconia/exchange.rb

@@ -1,32 +0,0 @@
-require 'danconia/stores/in_memory'
-
-module Danconia
-  class Exchange
-    attr_reader :store
-
-    def initialize store: Stores::InMemory.new
-      @store = store
-    end
-
-    def rate from, to
-      if from == 'USD' and direct_rate = @store.direct_rate(from, to)
-        direct_rate
-      elsif to == 'USD' and inverse_rate = @store.direct_rate(to, from)
-        (1.0 / inverse_rate).round 6
-      elsif from != 'USD' and to != 'USD' and from_in_usd = rate(from, 'USD') and to_per_usd = rate('USD', to)
-        (from_in_usd * to_per_usd).round 6
-      else
-        raise Errors::ExchangeRateNotFound.new(from, to)
-      end
-    end
-
-    def rates
-      @store.rates
-    end
-
-    # Currently is only needed for money formatting
-    def available_currencies
-      []
-    end
-  end
-end

data/spec/support/helpers.rb

@@ -1,7 +0,0 @@
-module Helpers
-  def with_config &block
-    old_config = Danconia.config.dup
-    Danconia.configure &block
-    Danconia.config = old_config
-  end
-end