eu_central_bank 1.4.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 01a35ff1906fc6fcb306bff2804ed3684b8925ab
-  data.tar.gz: 56e430e88205e5f30248570cacc32d7cfdcd7270
+SHA256:
+  metadata.gz: b589452c483bac16b40ab1372829694c9f261b9c802381110ed00fcebb73eaa6
+  data.tar.gz: 551614b051eb56ef4c10be19a5e796ebe0194287e1c278d374ae12f9aa5a2b9e
 SHA512:
-  metadata.gz: e84505f83a5c70373b71cb0f07325fef8e11c313fa4936e607bc5162531b666a5e04f53a9dedf18270113ce402d3f3c65948cfac7633d1146782c437e64079fe
-  data.tar.gz: beef6198548c17b60f27e0151cee6df2a59280ebdd7c4261621ca4359274ada0aa6d7043db5e6d25be2e54330e3a150f6aea1dc7b671d4fff0bf96138dcafe30
+  metadata.gz: 0774ff56419fa0b24d71d8747259b1464468e3cbdb4b6db52808bf3ab9e6023cdb4a00f92e387df9e27fb9d84a16a933a588f49e7d7355db86704fa0a67ab8d7
+  data.tar.gz: 1f2a24bfd29add88ea0c537b2b7be8a245bcd8fdbe8a7bda04474757e3df9b8ebb62271b34e8dadfc029c2918b4d5c80f4a6783f043eb22d9447f29911db2534

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # eu_central_bank changelog
 
+## 1.7.0 (Nov 17 2021)
+
+* Support historical rates
+
+## 1.6.1 (Mar 3 2021)
+
+* Allow a fallback when loading cached rate files to inhibit network fetch. 
+
+## 1.5.0 (Dec 7 2019)
+
+* Fix issue with money gem incompatibility
+* Fix thread safety of the default rates store
+* Bump money dependency to >= 6.13.6
+
 ## 1.4.2 (Feb 2 2019)
 
 * Fix issue with importing exported rates

data/LICENSE

@@ -1,20 +1,22 @@
+MIT License
+
 Copyright (c) 2009 Wong Liang Zan
+Copyright (c) 2021 Shane Emmons
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -25,7 +25,7 @@ gem 'nokogiri', '1.6.8'
 
 ## Usage
 
-With the gem, you do not need to manually add exchange rates. Calling update_rates will download the rates from the European Central Bank. The API is the same as the money gem. Feel free to use Money objects with the bank.
+With the gem, you do not need to manually add exchange rates. Calling `update_rates` will download the rates from the European Central Bank. The API is the same as the money gem. Feel free to use Money objects with the bank.
 
 ``` ruby
 require 'eu_central_bank'

data/lib/eu_central_bank/rates_document.rb

@@ -0,0 +1,45 @@
+class EuCentralBank < Money::Bank::VariableExchange
+  class RatesDocument < Nokogiri::XML::SAX::Document
+    attr_reader :rates
+    attr_reader :errors
+    attr_reader :updated_at
+
+    def initialize
+      @rates = {}
+      @errors = []
+      @updated_at = nil
+      @current_date = nil
+    end
+
+    def error(msg)
+      # TODO: remove this workaround after
+      # https://github.com/sparklemotion/nokogiri/pull/1872
+      # is released
+      @errors << msg
+      super
+    end
+
+    def start_element(name, attributes=[])
+      return if name != 'Cube' || attributes.empty?
+      begin
+        first_name, first_value = attributes[0]
+        case first_name
+        when 'time'
+          @current_date = Time.parse(first_value).to_date
+          @updated_at ||= @current_date
+          @rates[@current_date] = []
+        when 'currency'
+          currency = first_value
+          _, rate = attributes[1]
+          @rates[@current_date] << [currency, rate]
+        end
+      rescue StandardError => e
+        raise Nokogiri::XML::XPath::SyntaxError, e.message
+      end
+    end
+
+    def end_document
+      raise Nokogiri::XML::XPath::SyntaxError if @rates.empty? || @updated_at.nil?
+    end
+  end
+end

data/lib/eu_central_bank.rb

@@ -2,6 +2,7 @@ require 'open-uri'
 require 'nokogiri'
 require 'money'
 require 'money/rates_store/store_with_historical_data_support'
+require 'eu_central_bank/rates_document'
 
 class InvalidCache < StandardError ; end
 
@@ -15,38 +16,47 @@ class EuCentralBank < Money::Bank::VariableExchange
   attr_accessor :historical_rates_updated_at
 
   SERIALIZER_DATE_SEPARATOR = '_AT_'
-
+  DECIMAL_PRECISION = 5
   CURRENCIES = %w(USD JPY BGN CZK DKK GBP HUF ILS ISK PLN RON SEK CHF NOK HRK RUB TRY AUD BRL CAD CNY HKD IDR INR KRW MXN MYR NZD PHP SGD THB ZAR).map(&:freeze).freeze
   ECB_RATES_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml'.freeze
   ECB_90_DAY_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml'.freeze
+  ECB_ALL_HIST_URL = 'https://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist.xml'.freeze
+
+  LEGACY_CURRENCIES = %w(CYP SIT ROL TRL)
 
   def initialize(st = Money::RatesStore::StoreWithHistoricalDataSupport.new, &block)
     super
     @currency_string = nil
   end
 
-  def update_rates(cache=nil)
-    update_parsed_rates(doc(cache))
+  def update_rates(cache=nil, url=ECB_RATES_URL)
+    update_parsed_rates(doc(cache, url))
   end
 
-  def update_historical_rates(cache=nil)
-    update_parsed_historical_rates(doc(cache, ECB_90_DAY_URL))
+  def update_historical_rates(cache=nil, all=false)
+    url = all ? ECB_ALL_HIST_URL : ECB_90_DAY_URL
+    update_parsed_historical_rates(doc(cache, url))
   end
 
   def save_rates(cache, url=ECB_RATES_URL)
     raise InvalidCache unless cache
     File.open(cache, "w") do |file|
-      io = open(url);
+      io = open_url(url)
       io.each_line { |line| file.puts line }
     end
   end
 
+  def save_historical_rates(cache, all=false)
+    url = all ? ECB_ALL_HIST_URL : ECB_90_DAY_URL
+    save_rates(cache, url)
+  end
+
   def update_rates_from_s(content)
-    update_parsed_rates(doc_from_s(content))
+    update_parsed_rates(parse_rates(content))
   end
 
   def save_rates_to_s(url=ECB_RATES_URL)
-    open(url).read
+    open_url(url).read
   end
 
   def exchange(cents, from_currency, to_currency, date=nil)
@@ -146,7 +156,7 @@ class EuCentralBank < Money::Bank::VariableExchange
         from, to = key.split(SERIALIZER_SEPARATOR)
         to, date = to.split(SERIALIZER_DATE_SEPARATOR)
 
-        store.add_rate from, to, BigDecimal(rate), date
+        store.add_rate from, to, BigDecimal(rate, DECIMAL_PRECISION), date
       end
     end
 
@@ -164,48 +174,53 @@ class EuCentralBank < Money::Bank::VariableExchange
 
   def doc(cache, url=ECB_RATES_URL)
     rates_source = !!cache ? cache : url
-    Nokogiri::XML(open(rates_source)).tap { |doc| doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube') }
-  rescue Nokogiri::XML::XPath::SyntaxError
-    Nokogiri::XML(open(url))
+    begin
+      parse_rates(open_url(rates_source))
+    rescue Nokogiri::XML::XPath::SyntaxError
+      parse_rates(open_url(url))
+    end
   end
 
-  def doc_from_s(content)
-    Nokogiri::XML(content)
-  end
+  def parse_rates(io)
+    doc = ::EuCentralBank::RatesDocument.new
+    parser = Nokogiri::XML::SAX::Parser.new(doc)
+    parser.parse(io)
 
-  def update_parsed_rates(doc)
-    rates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
+    unless doc.errors.empty?
+      # Temporary workaround for jruby until
+      # https://github.com/sparklemotion/nokogiri/pull/1872 gets
+      # released and we bump nokogiri version to include it.
+      # TLDR: jruby version of SAX parser will mask all the exceptions
+      # raised in document so we will raise it here if there were errors.
+      raise Nokogiri::XML::XPath::SyntaxError, doc.errors.join("\n")
+    end
 
-    store.transaction true do
-      rates.each do |exchange_rate|
-        rate = BigDecimal(exchange_rate.attribute("rate").value)
-        currency = exchange_rate.attribute("currency").value
-        set_rate("EUR", currency, rate)
+    doc
+  end
+
+  def copy_rates(rates_document, with_date = false)
+    rates_document.rates.each do |date, rates|
+      rates.each do |currency, rate|
+        next if LEGACY_CURRENCIES.include?(currency)
+        set_rate('EUR', currency, BigDecimal(rate, DECIMAL_PRECISION), with_date ? date : nil)
       end
-      set_rate("EUR", "EUR", 1)
+      set_rate('EUR', 'EUR', 1, with_date ? date : nil)
     end
+  end
 
-    rates_updated_at = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube/@time').first.value
-    @rates_updated_at = Time.parse(rates_updated_at)
-
+  def update_parsed_rates(rates_document)
+    store.transaction true do
+      copy_rates(rates_document)
+    end
+    @rates_updated_at = rates_document.updated_at
     @last_updated = Time.now
   end
 
-  def update_parsed_historical_rates(doc)
-    rates = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube//xmlns:Cube')
-
+  def update_parsed_historical_rates(rates_document)
     store.transaction true do
-      rates.each do |exchange_rate|
-        rate = BigDecimal(exchange_rate.attribute("rate").value)
-        currency = exchange_rate.attribute("currency").value
-        date = exchange_rate.parent.attribute("time").value
-        set_rate("EUR", currency, rate, date)
-      end
+      copy_rates(rates_document, true)
     end
-
-    rates_updated_at = doc.xpath('gesmes:Envelope/xmlns:Cube/xmlns:Cube/@time').first.value
-    @historical_rates_updated_at = Time.parse(rates_updated_at)
-
+    @historical_rates_updated_at = rates_document.updated_at
     @historical_last_updated = Time.now
   end
 
@@ -214,8 +229,16 @@ class EuCentralBank < Money::Bank::VariableExchange
   def calculate_exchange(from, to_currency, rate)
     to_currency_money = Money::Currency.wrap(to_currency).subunit_to_unit
     from_currency_money = from.currency.subunit_to_unit
-    decimal_money = BigDecimal(to_currency_money) / BigDecimal(from_currency_money)
+    decimal_money = BigDecimal(to_currency_money, DECIMAL_PRECISION) / BigDecimal(from_currency_money, DECIMAL_PRECISION)
     money = (decimal_money * from.cents * rate).round
     Money.new(money, to_currency)
   end
+
+  def open_url(url)
+    if RUBY_VERSION >= '2.5.0'
+      URI.open(url)
+    else
+      open(url)
+    end
+  end
 end

data/lib/money/rates_store/store_with_historical_data_support.rb

@@ -3,33 +3,16 @@ module Money::RatesStore
     INDEX_DATE_SEPARATOR = '_AT_'.freeze
 
     def add_rate(currency_iso_from, currency_iso_to, rate, date = nil)
-      transaction { index[rate_key_for(currency_iso_from, currency_iso_to, date)] = rate }
+      transaction { rates[rate_key_for(currency_iso_from, currency_iso_to, date)] = rate }
     end
 
     def get_rate(currency_iso_from, currency_iso_to, date = nil)
-      transaction { index[rate_key_for(currency_iso_from, currency_iso_to, date)] }
+      transaction { rates[rate_key_for(currency_iso_from, currency_iso_to, date)] }
     end
 
     # Wraps block execution in a thread-safe transaction
-    def transaction(force_sync = false, &block)
-      # Ruby 1.9.3 does not support @mutex.owned?
-      if @mutex.respond_to?(:owned?)
-        force_sync = false if @mutex.locked? && @mutex.owned?
-      else
-        # If we allowed this in Ruby 1.9.3, it might possibly cause recursive
-        # locking within the same thread.
-        force_sync = false
-      end
-      if !force_sync && (@in_transaction || options[:without_mutex])
-        block.call self
-      else
-        @mutex.synchronize do
-          @in_transaction = true
-          result = block.call
-          @in_transaction = false
-          result
-        end
-      end
+    def transaction(_force_sync = false, &block)
+      super(&block)
     end
 
     # Iterate over rate tuples (iso_from, iso_to, rate)
@@ -47,7 +30,7 @@ module Money::RatesStore
     #   end
     def each_rate(&block)
       enum = Enumerator.new do |yielder|
-        index.each do |key, rate|
+        rates.each do |key, rate|
           iso_from, iso_to = key.split(Memory::INDEX_KEY_SEPARATOR)
           iso_to, date = iso_to.split(INDEX_DATE_SEPARATOR)
           date = Date.parse(date) if date
@@ -60,10 +43,10 @@ module Money::RatesStore
 
     private
 
-      def rate_key_for(currency_iso_from, currency_iso_to, date = nil)
-        key = [currency_iso_from, currency_iso_to].join(Memory::INDEX_KEY_SEPARATOR)
-        key = [key, date.to_s].join(INDEX_DATE_SEPARATOR) if date
-        key.upcase
-      end
+    def rate_key_for(currency_iso_from, currency_iso_to, date = nil)
+      key = [currency_iso_from, currency_iso_to].join(Memory::INDEX_KEY_SEPARATOR)
+      key = [key, date.to_s].join(INDEX_DATE_SEPARATOR) if date
+      key.upcase
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eu_central_bank
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Shane Emmons
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.13.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.13.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -64,11 +70,13 @@ files:
 - LICENSE
 - README.md
 - lib/eu_central_bank.rb
+- lib/eu_central_bank/rates_document.rb
 - lib/money/rates_store/store_with_historical_data_support.rb
 homepage: https://github.com/RubyMoney/eu_central_bank
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,9 +91,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Calculates exchange rates based on rates from european central bank. Money
   gem compatible.