danconia 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7427977cd93825975491eddf43bcd9e5fda9389102d2c2b32c16efdfb11f590
-  data.tar.gz: 15bccf8fc66c26679cc101d5f27dd9aabc5398b28fe1a04a00b167500993eedf
+  metadata.gz: d059c26cfe3dfb8fdd9da2a14f14d4207f49d39e57a8ac11624e4069f1612632
+  data.tar.gz: 2a7022742e0c9fdb318d57bf916828c18eab1c040aa7ec571912e243aef14028
 SHA512:
-  metadata.gz: 95d1edfd74b3388998c3251ac204a61a10a7454e0eda2fc2ca3b6105f95d9ead47c511a67790e82d34d4d54f934db83cc7326da53abef51c074846571b28a819
-  data.tar.gz: 033bb6ae1f171059bceb87495b9490b2d760f6371d71ec74f8a6a494f628ab52302f91f19f2a0e9f344c9c4775fecd0027c071e0cc21db51568e1efd80ea8c70
+  metadata.gz: 6c3ad4d5a0d58ca3fb6be34d557dfec5ef0578adf627edc2de3c7cee8b68eab84aafcebbf58c59e5622974dc8b2b7e609dd58e1d7dcf502eacd2090610ed7b4a
+  data.tar.gz: 439f6bb772fdef77bc221c6e4167a053b6366ff39fe8b20c3b6f81393901bc7c8364c1c326e357c0d2160ecd7bb50734cbdf1ae37eeb169bd2232b93e13e5181

data/.rubocop.yml

@@ -0,0 +1,104 @@
+Style/Documentation:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/MultilineIfModifier:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/TrailingEmptyLines:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Bundler:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    danconia (0.2.9)
-      activerecord (>= 3.0.0)
+    danconia (0.3.0)
+      activesupport (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,6 +20,7 @@ GEM
       zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.1)
     coderay (1.1.2)
     concurrent-ruby (1.1.7)
     crack (0.4.3)
@@ -44,25 +45,34 @@ GEM
     hashdiff (0.3.7)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
     method_source (0.9.0)
+    mini_portile2 (2.4.0)
     minitest (5.14.2)
     nenv (0.3.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.2)
+    rainbow (3.0.0)
     rake (13.0.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
+    rexml (3.2.4)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -76,6 +86,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
@@ -84,6 +103,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
     webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -94,11 +114,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (>= 4.0)
   danconia!
   guard
   guard-rspec
+  nokogiri
   rake
   rspec
+  rubocop (~> 0.80.0)
   sqlite3
   webmock
 

data/README.md

@@ -1,9 +1,19 @@
 # Danconia
 
-A very simple money library for Ruby, backed by BigDecimal (no conversion to cents, i.e. "infinite precision") with support for external exchange rates services.
+A very simple money library for Ruby, backed by BigDecimal, with multi-currency support.
 
 [![Build Status](https://travis-ci.org/eeng/danconia.svg?branch=master)](https://travis-ci.org/eeng/danconia)
 
+## Features
+
+* Backed by BigDecimal (no conversion to cents is done, i.e. "infinite precision")
+* Multi-currency support
+* Pluggable exchange rates services:
+  - [CurrencyLayer API](https://currencylayer.com/)
+  - [BNA](https://www.bna.com.ar/)
+  - FixedRates (for testing use)
+* Pluggable stores for persisting the exchange rates
+
 ## Installation
 
 ```ruby
@@ -29,10 +39,12 @@ Please refer to `examples/single_currency.rb` for some configuration options.
 
 ## Multi-Currency Support
 
-To handle multiple currencies you need to configure an `Exchange` in order to fetch the rates. For example, with [CurrencyLayer](https://currencylayer.com/):
+To handle multiple currencies you need to configure an `Exchange` in order to fetch the rates. For example, with CurrencyLayer:
 
 ```ruby
 # This can be placed in a Rails initializer
+require 'danconia/exchanges/currency_layer'
+
 Danconia.configure do |config|
   config.default_exchange = Danconia::Exchanges::CurrencyLayer.new(access_key: '...')
 end
@@ -56,6 +68,8 @@ By default, rates are stored in memory, but you can supply a store in the exchan
 Given a `products` table with a decimal column `price` and a string column `price_currency` (optional), then you can use the `money` class method to automatically convert it to Money:
 
 ```ruby
+require 'danconia/integrations/active_record'
+
 class Product < ActiveRecord::Base
   money :price
 end

data/danconia.gemspec

@@ -17,11 +17,15 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.add_dependency "activerecord", '>= 3.0.0'
+
+  gem.add_dependency 'activesupport', '>= 4.0'
+  gem.add_development_dependency "activerecord", '>= 4.0'
   gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "guard"
   gem.add_development_dependency "guard-rspec"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "webmock"
+  gem.add_development_dependency "nokogiri"
+  gem.add_development_dependency 'rubocop', '~> 0.80.0'
 end

data/examples/bna.rb

@@ -0,0 +1,35 @@
+# Example using BNA (Banco Nación de Argentina) and storing rates daily in ActiveRecord.
+
+require 'danconia/integrations/active_record'
+require 'danconia/exchanges/bna'
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Schema.define do
+  # You can use this in a Rails migration
+  create_table :exchange_rates do |t|
+    t.date :date
+    t.string :pair, limit: 6
+    t.string :rate_type
+    t.decimal :rate, precision: 12, scale: 6
+    t.index [:date, :pair, :rate_type], unique: true
+  end
+end
+
+Danconia.configure do |config|
+  config.default_exchange = Danconia::Exchanges::BNA.new(
+    store: Danconia::Stores::ActiveRecord.new(unique_keys: %i[date pair rate_type], date_field: :date)
+  )
+end
+
+# Periodically call this method to keep the rates up to date
+puts 'Updating rates...'
+Danconia.config.default_exchange.update_rates!
+
+# Uses the latest rate
+puts Money(1, 'USD').exchange_to('ARS', rate_type: 'billetes').inspect
+puts Money(1, 'USD').exchange_to('ARS', rate_type: 'divisas').inspect
+
+# Raises Danconia::Errors::ExchangeRateNotFound as there is no rate for that date
+# Money(1, 'USD').exchange_to('ARS', rate_type: 'billetes', date: Date.new(2000))

data/examples/currency_layer.rb

@@ -1,4 +1,9 @@
+# Example using CurrencyLayer API and storing only the latests rates in ActiveRecord.
 # Remember to supply your CurrencyLayer key in the ACCESS_KEY environment variable to run this example
+
+require 'danconia/integrations/active_record'
+require 'danconia/exchanges/currency_layer'
+
 ActiveRecord::Base.logger = Logger.new(STDOUT)
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
 
@@ -18,8 +23,8 @@ Danconia.configure do |config|
   )
 end
 
-# Periodically call this method to keep rates up to date
-puts 'Updating dates with CurrencyLayer API...'
+# Periodically call this method to keep the rates up to date
+puts 'Updating rates...'
 Danconia.config.default_exchange.update_rates!
 
 puts Money(1, 'USD').exchange_to('EUR').inspect # => 0.854896 EUR

data/examples/single_currency.rb

@@ -1,6 +1,7 @@
+# Example showing how to use a single currency.
+
 # USD is the default currency if no configuration is provided
-puts (Money(10.25) / 2).inspect # => 5.125 USD
-puts (Money(10.25) / 2).to_s # => $5.13
+puts Money(10.25).inspect # => 5.125 USD
 
 # Lets switch to other currency
 Danconia.configure do |config|

data/lib/danconia.rb

@@ -1,11 +1,13 @@
+require 'date'
+
+require 'active_support'
+require 'active_support/core_ext/object/blank'
+
 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/lib/danconia/currency.rb

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

data/lib/danconia/exchange.rb

@@ -0,0 +1,47 @@
+require 'danconia/pair'
+
+module Danconia
+  class Exchange
+    def rate from, to, **opts
+      return 1.0 if from == to
+
+      pair = Pair.new(from, to)
+      rates = direct_and_inverted_rates(opts)
+      rates[pair] or indirect_rate(pair, rates) or raise Errors::ExchangeRateNotFound.new(from, to)
+    end
+
+    # Override this method in subclasses. Should return a map of pairs to rates.
+    # See `FixedRates` for an example implementation.
+    def rates **_opts
+      raise NotImplementedError
+    end
+
+    private
+
+    # Returns the original rates plus the inverted ones, to simplify rate finding logic.
+    # Also wraps the pair strings into Pair objects.
+    def direct_and_inverted_rates opts
+      rates(opts).each_with_object({}) do |(pair_str, rate), rs|
+        pair = Pair.parse(pair_str)
+        rs[pair] = rate
+        rs[pair.invert] ||= 1.0 / rate
+      end
+    end
+
+    def indirect_rate ind_pair, rates
+      if (from_pair = rates.keys.detect { |pair| pair.from == ind_pair.from }) &&
+         (to_pair = rates.keys.detect { |pair| pair.to == ind_pair.to })
+        rates[from_pair] * rates[to_pair]
+      end
+    end
+
+    def array_of_rates_to_hash array
+      pairs = array.map { |er| er[:pair] }
+      if pairs.size != pairs.uniq.size
+        raise ArgumentError, "Exchange returned duplicate pairs. Maybe you forgot a filter?\n#{array}"
+      end
+
+      Hash[array.map { |er| er.values_at(:pair, :rate) }]
+    end
+  end
+end

data/lib/danconia/exchanges/bna.rb

@@ -0,0 +1,61 @@
+require 'danconia/errors/api_error'
+require 'net/http'
+require 'nokogiri'
+
+module Danconia
+  module Exchanges
+    # The BNA does not provide an API to pull the rates, so this implementation scrapes the home HTML directly.
+    # Returns rates of both types, "Billetes" and "Divisas", and only the "tipo de cambio vendedor" ones.
+    # See `examples/bna.rb` for a complete usage example.
+    class BNA < Exchange
+      attr_reader :store
+
+      def initialize store: Stores::InMemory.new
+        @store = store
+      end
+
+      def fetch_rates
+        response = Net::HTTP.get URI 'https://www.bna.com.ar/Personas'
+        scrape_rates(response, 'billetes') + scrape_rates(response, 'divisas')
+      end
+
+      def update_rates!
+        @store.save_rates fetch_rates
+      end
+
+      def rates rate_type:, date: nil
+        array_of_rates_to_hash @store.rates(rate_type: rate_type, date: date)
+      end
+
+      private
+
+      def scrape_rates response, type
+        doc = Nokogiri::XML(response).css("##{type}")
+
+        if doc.css('thead th:last-child').text != 'Venta'
+          raise Errors::APIError, "Could not scrape '#{type}' rates. Maybe the format changed?"
+        end
+
+        doc.css('tbody tr').map do |row|
+          pair = parse_pair(row.css('td:first-child').text) or next
+          rate = parse_rate(row.css('td:last-child').text, pair)
+          date = Date.parse(doc.css('.fechaCot').text)
+          {pair: pair, rate: rate, date: date, rate_type: type}
+        end.compact.presence or raise Errors::APIError, "Could not scrape '#{type}' rates. Maybe the format changed?"
+      end
+
+      def parse_pair cur_name
+        case cur_name
+        when 'Dolar U.S.A' then 'USDARS'
+        when 'Euro' then 'EURARS'
+        when 'Real *' then 'BRLARS'
+        end
+      end
+
+      def parse_rate str, pair
+        val = Float(str.tr(',', '.'))
+        pair == 'BRLARS' ? val / 100.0 : val
+      end
+    end
+  end
+end