money-currencylayer-bank 0.5.3 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2954dfb52185c910cfed6a3f3b1def920c80c847
-  data.tar.gz: 408ba3963b1c258ce322e69237c951f34988ba1e
+SHA256:
+  metadata.gz: b3c0fb9028cd1aeffa15e39f1ac11611a98ebc98c4388b3d7e15c3926f186ae2
+  data.tar.gz: 4cd0872bd7ddf5957a80b344a781656532b98c77b4eaf69f1d5b36eb6b4b4a48
 SHA512:
-  metadata.gz: f1696528b4ac735817a8fc476b1b5a3e87512ce4e167baf36601a794ef6de6a521c0496a05f943e0ca9f643ab2f3a1361f4e5a663d32a4a684df27f1894a62fa
-  data.tar.gz: a58368adeb7bbc501e5ef1e13f55e9deff90084b7b45f9021c1f49b9bb4241b4acfee44303e28f7002efdfc56c230547b98b149c59b3c4bcf34633a597c2e0cc
+  metadata.gz: cddb985e9d2f028674acff2e4f5605ff9d504396abbcec1e63cadadc3ea7a9620517e9af28d622fccf4729a70e0500918b6f9d218e38d01d42dd1fb91cc00581
+  data.tar.gz: b138d9a8d0ca0fa1ece3d4c576088ad7fe6e023b96fd3d21537e048764df887c871e9eebc2cfe8c425bca682aa20e63d2e1a38ebc0259611ee2a57f8bfb9e7a3

data/Gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
 group :test, :development do
   platforms :ruby_19, :jruby_19 do
-    gem 'tins', '~> 1.6.0'
+    gem 'tins', '~> 1.6'
   end
 end

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Phlegx Systems OG
+Copyright (c) 2017 Phlegx Systems OG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -40,6 +40,7 @@ See more about Currencylayer product plans on https://currencylayer.com/product.
 * average response time < 20ms
 * supports caching currency rates
 * calculates every pair rate calculating inverse rate or using base currency rate
+* supports multiple server instances, thread safe
 
 ## Installation
 
@@ -89,7 +90,7 @@ mclb.secure_connection = true
 # Define cache (string or pathname)
 mclb.cache = 'path/to/file/cache'
 
-# Set money default bank to currencylayer bank
+# Set money default bank to Currencylayer bank
 Money.default_bank = mclb
 ~~~
 
@@ -104,7 +105,7 @@ mclb.source
 # Expires rates if the expiration time is reached.
 mclb.expire_rates!
 
-# Return true if the expiration time is reached.
+# Returns true if the expiration time is reached.
 mclb.expired?
 
 # Get the API source url.
@@ -112,6 +113,9 @@ mclb.source_url
 
 # Get the rates timestamp of the last API request.
 mclb.rates_timestamp
+
+# Get the rates timestamp of loaded rates in memory.
+moxb.rates_mem_timestamp
 ~~~
 
 ### How to exchange
@@ -184,6 +188,7 @@ bundle exec rake
 ## Other Implementations
 
 * Gem [currencylayer](https://github.com/askuratovsky/currencylayer)
+* Gem [money-openexchangerates-bank](https://github.com/phlegx/money-openexchangerates-bank)
 * Gem [money-open-exchange-rates](https://github.com/spk/money-open-exchange-rates)
 * Gem [money-historical-bank](https://github.com/atwam/money-historical-bank)
 * Gem [eu_central_bank](https://github.com/RubyMoney/eu_central_bank)
@@ -207,4 +212,4 @@ bundle exec rake
 
 The MIT License
 
-Copyright (c) 2015 Phlegx Systems OG
+Copyright (c) 2017 Phlegx Systems OG

data/lib/money/bank/currencylayer_bank.rb

@@ -1,10 +1,25 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'money'
 require 'json'
 
 # Money gem class
 class Money
+  # Build in memory rates store
+  module RatesStore
+    # Memory class
+    class Memory
+      # Add method to reset the build in memory store
+      # @param [Hash] rt Optional initial exchange rate data.
+      # @return [Object] store.
+      def reset!(rt = {})
+        transaction { @index = rt }
+      end
+    end
+  end
+
   # https://github.com/RubyMoney/money#exchange-rate-stores
   module Bank
     # Invalid cache, file not found or cache empty
@@ -14,12 +29,11 @@ class Money
     class NoAccessKey < StandardError; end
 
     # CurrencylayerBank base class
-    # rubocop:disable Metrics/ClassLength
     class CurrencylayerBank < Money::Bank::VariableExchange
       # CurrencylayerBank url
       CL_URL = 'http://apilayer.net/api/live'.freeze
       # CurrencylayerBank secure url
-      CL_SECURE_URL = CL_URL.gsub('http:', 'https:').freeze
+      CL_SECURE_URL = CL_URL.sub('http:', 'https:')
       # Default base currency
       CL_SOURCE = 'USD'.freeze
 
@@ -28,27 +42,28 @@ class Money
       # for the free plan users.
       #
       # @param value [Boolean] true for secure connection
-      #
       # @return [Boolean] chosen secure connection
       attr_accessor :secure_connection
 
       # API must have a valid access_key
       #
       # @param value [String] API access key
-      #
       # @return [String] chosen API access key
       attr_accessor :access_key
 
       # Cache accessor, can be a String or a Proc
       #
       # @param value [String,Pathname,Proc] cache system
-      #
       # @return [String,Pathname,Proc] chosen cache system
       attr_accessor :cache
 
       # Parsed CurrencylayerBank result as Hash
       attr_reader :rates
 
+      # Get the timestamp of rates in memory
+      # @return [Time] time object or nil
+      attr_reader :rates_mem_timestamp
+
       # Set the seconds after than the current rates are automatically expired
       # by default, they never expire.
       #
@@ -56,7 +71,6 @@ class Money
       #   ttl_in_seconds = 86400 # will expire the rates in one day
       #
       # @param value [Integer] time to live in seconds
-      #
       # @return [Integer] chosen time to live in seconds
       attr_writer :ttl_in_seconds
 
@@ -68,7 +82,6 @@ class Money
       #   source = 'USD'
       #
       # @param value [String] Currency code, ISO 3166-1 alpha-3
-      #
       # @return [String] chosen base currency
       def source=(value)
         @source = Money::Currency.find(value.to_s).try(:iso_code) || CL_SOURCE
@@ -90,57 +103,50 @@ class Money
       # Update all rates from CurrencylayerBank JSON
       # @return [Array] array of exchange rates
       def update_rates(straight = false)
-        exchange_rates(straight).each do |exchange_rate|
+        store.reset!
+        rates = exchange_rates(straight).each do |exchange_rate|
           currency = exchange_rate.first[3..-1]
           rate = exchange_rate.last
           next unless Money::Currency.find(currency)
           add_rate(source, currency, rate)
           add_rate(currency, source, 1.0 / rate)
         end
+        @rates_mem_timestamp = rates_timestamp
+        rates
       end
 
+      # Override Money `add_rate` method for caching
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      # @return [Numeric] rate.
+      def add_rate(from_currency, to_currency, rate)
+        super
+      end
+
+      # Alias super method
+      alias super_get_rate get_rate
+
       # Override Money `get_rate` method for caching
       # @param [String] from_currency Currency ISO code. ex. 'USD'
       # @param [String] to_currency Currency ISO code. ex. 'CAD'
-      #
+      # @param [Hash] opts Options hash to set special parameters.
       # @return [Numeric] rate.
-      def get_rate(from_currency, to_currency, opts = {}) # rubocop:disable all
+      def get_rate(from_currency, to_currency, opts = {})
         expire_rates!
-        rate = super
-        unless rate
-          # Tries to calculate an inverse rate
-          inverse_rate = super(to_currency, from_currency, opts)
-          if inverse_rate
-            rate = 1.0 / inverse_rate
-            add_rate(from_currency, to_currency, rate)
-          end
-        end
-        unless rate
-          # Tries to calculate a pair rate using base currency rate
-          from_base_rate = super(source, from_currency, opts)
-          unless from_base_rate
-            from_inverse_rate = super(from_currency, source, opts)
-            from_base_rate = 1.0 / from_inverse_rate if from_inverse_rate
-          end
-          to_base_rate = super(source, to_currency, opts)
-          unless to_base_rate
-            to_inverse_rate = super(to_currency, source, opts)
-            to_base_rate = 1.0 / to_inverse_rate if to_inverse_rate
-          end
-          if to_base_rate && from_base_rate
-            rate = to_base_rate / from_base_rate
-            add_rate(from_currency, to_currency, rate)
-          end
-        end
-        rate
+        rate = get_rate_or_calc_inverse(from_currency, to_currency, opts)
+        rate || calc_pair_rate_using_base(from_currency, to_currency, opts)
       end
 
-      # Fetch new rates if cached rates are expired
+      # Fetch new rates if cached rates are expired or stale
       # @return [Boolean] true if rates are expired and updated from remote
       def expire_rates!
         if expired?
           update_rates(true)
           true
+        elsif stale?
+          update_rates
+          true
         else
           false
         end
@@ -152,6 +158,14 @@ class Money
         Time.now > rates_expiration
       end
 
+      # Check if rates are stale
+      # Stale is true if rates are updated straight by another thread.
+      # The actual thread has always old rates in memory store.
+      # @return [Boolean] true if rates are stale
+      def stale?
+        rates_timestamp != rates_mem_timestamp
+      end
+
       # Source url of CurrencylayerBank
       # defined with access_key and secure_connection
       # @return [String] the remote API url
@@ -226,7 +240,7 @@ class Money
       # Opens an url and reads the content
       # @return [String] unparsed JSON content
       def open_url
-        open(source_url).read
+        ::OpenURI.open_uri(source_url).read
       rescue OpenURI::HTTPError
         ''
       end
@@ -262,6 +276,7 @@ class Money
       end
 
       # Get raw exchange rates from cache and then from url
+      # @param rescue_straight [Boolean] true for rescue straight, default true
       # @return [String] JSON content
       def raw_rates_careful(rescue_straight = true)
         JSON.parse(read_from_cache.to_s)
@@ -276,6 +291,38 @@ class Money
       rescue JSON::ParserError
         raw_rates_careful(false)
       end
+
+      # Get rate or calculate it as inverse rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @return [Numeric] rate or rate calculated as inverse rate.
+      def get_rate_or_calc_inverse(from_currency, to_currency, opts = {})
+        rate = super_get_rate(from_currency, to_currency, opts)
+        unless rate
+          # Tries to calculate an inverse rate
+          inverse_rate = super_get_rate(to_currency, from_currency, opts)
+          if inverse_rate
+            rate = 1.0 / inverse_rate
+            add_rate(from_currency, to_currency, rate)
+          end
+        end
+        rate
+      end
+
+      # Tries to calculate a pair rate using base currency rate
+      # @param [String] from_currency Currency ISO code. ex. 'USD'
+      # @param [String] to_currency Currency ISO code. ex. 'CAD'
+      # @return [Numeric] rate or nil if cannot calculate rate.
+      def calc_pair_rate_using_base(from_currency, to_currency, opts = {})
+        from_base_rate = get_rate_or_calc_inverse(source, from_currency, opts)
+        to_base_rate   = get_rate_or_calc_inverse(source, to_currency, opts)
+        if to_base_rate && from_base_rate
+          rate = to_base_rate / from_base_rate
+          add_rate(from_currency, to_currency, rate)
+          return rate
+        end
+        nil
+      end
     end
   end
 end

data/test/currencylayer_bank_test.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
 describe Money::Bank::CurrencylayerBank do
@@ -208,9 +210,12 @@ describe Money::Bank::CurrencylayerBank do
         delimiter: ','
       }
       Money::Currency.register(wtf)
-      subject.add_rate('USD', 'WTF', 2)
-      subject.add_rate('WTF', 'USD', 2)
-      subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
+      Timecop.freeze(subject.rates_timestamp) do
+        subject.add_rate('USD', 'WTF', 2)
+        subject.add_rate('WTF', 'USD', 2)
+        subject.exchange_with(5000.to_money('WTF'), 'USD').cents
+        subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
+      end
     end
   end
 
@@ -232,9 +237,10 @@ describe Money::Bank::CurrencylayerBank do
       @old_usd_eur_rate = 0.655
       # see test/live.json +54
       @new_usd_eur_rate = 0.886584
-      subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
       subject.cache = temp_cache_path
       stub(subject).source_url { data_path }
+      subject.update_rates
+      subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
     end
 
     after do

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'rr'
 require 'money/bank/currencylayer_bank'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.7
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -42,14 +42,14 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.49.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: 0.49.1
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
@@ -185,11 +185,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: A gem that calculates the exchange rate using published rates from currencylayer.com.
 test_files:
 - test/currencylayer_bank_test.rb
-has_rdoc: