money-currencylayer-bank 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c5a08a77bda99cbfcd572fbd6aec7d24a30e4ea
-  data.tar.gz: 17c697f0262bdedadf2c5bb9019364b10b3b8417
+  metadata.gz: 57c027e5e05e294bcaa1d9d8c62660a9b88dd164
+  data.tar.gz: 8ea8e257ea4fde758ab909d53955bba5d165a149
 SHA512:
-  metadata.gz: 8afffad25d2b2fe4ae7253d903487253fb838b3a8fe260dda2f2160d80cc896102c4afe1654ca0436e0785ab90178832048088d66761d6c2af1c7a5c6dc8a475
-  data.tar.gz: 033896568dfbe42df8e55042a7255390a2ed93a7257397e04cedd5d9357c2663f130cb5840193f24db752e706f3585e56276400b62574854bff7ee13d65907e2
+  metadata.gz: e67f41efcd22a9e3d388a8ab4c315e634ee9cc7e1b28344521dbbc52bdb65614fe05e28a6b538576ed7bac4c3433d39104d97c37482bc713d3b81513f368112a
+  data.tar.gz: 250b29148bf6119e1a22b8d58f9a9cd3d0b4b3e5812e65db7cfa1f8443482565edf786c290c6eb9c98c12a3183520814189b8543b3c8034855834767177fba01

data/README.md

@@ -14,7 +14,7 @@ A gem that calculates the exchange rate using published rates from
 ~~~ ruby
 # Minimal requirements
 require 'money/bank/currencylayer_bank'
-mclb = Money::Bank::MoneyCurrencylayerBank.new
+mclb = Money::Bank::CurrencylayerBank.new
 mclb.access_key = 'your access_key from https://currencylayer.com/product'
 
 # Update rates
@@ -53,7 +53,7 @@ You can also use it in Rails with the gem [money-rails](https://github.com/RubyM
 require 'money/bank/currencylayer_bank'
 
 MoneyRails.configure do |config|
-  mclb = Money::Bank::MoneyCurrencylayerBank.new
+  mclb = Money::Bank::CurrencylayerBank.new
   mclb.access_key = 'your access_key from https://currencylayer.com/product'
   mclb.update_rates
 

data/lib/money/bank/currencylayer_bank.rb

@@ -14,11 +14,12 @@ 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'
       # CurrencylayerBank secure url
-      SECURE_CL_URL = CL_URL.gsub('http:', 'https:')
+      CL_SECURE_URL = CL_URL.gsub('http:', 'https:')
       # Default base currency
       CL_SOURCE = 'USD'
 
@@ -37,7 +38,7 @@ class Money
       attr_reader :rates_expiration
 
       # Parsed CurrencylayerBank result as Hash
-      attr_reader :cl_rates
+      attr_reader :rates
 
       # Seconds after than the current rates are automatically expired
       attr_reader :ttl_in_seconds
@@ -73,14 +74,14 @@ class Money
       # @return [Integer] Setted time to live in seconds
       def ttl_in_seconds=(value)
         @ttl_in_seconds = value
-        refresh_rates_expiration if ttl_in_seconds
+        refresh_rates_expiration! if ttl_in_seconds
         @ttl_in_seconds
       end
 
       # Update all rates from CurrencylayerBank JSON
       # @return [Array] Array of exchange rates
-      def update_rates
-        exchange_rates.each do |exchange_rate|
+      def update_rates(straight = false)
+        exchange_rates(straight).each do |exchange_rate|
           currency = exchange_rate.first[3..-1]
           rate = exchange_rate.last
           next unless Money::Currency.find(currency)
@@ -89,34 +90,26 @@ class Money
         end
       end
 
-      # Save rates on cache
-      # Can raise InvalidCache
-      #
-      # @return [Proc,File]
-      def save_rates
-        fail InvalidCache unless cache
-        text = read_from_url
-        store_in_cache(text) if valid_rates?(text)
-      rescue Errno::ENOENT
-        raise InvalidCache
-      end
-
       # 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'
       #
       # @return [Numeric] rate.
       def get_rate(from_currency, to_currency, opts = {})
-        expire_rates
+        expire_rates!
         super
       end
 
       # Expire rates when expired
-      def expire_rates
-        return unless ttl_in_seconds
-        return if rates_expiration > Time.now
-        update_rates
-        refresh_rates_expiration
+      def expire_rates!
+        return unless expired?
+        update_rates(true)
+      end
+
+      # Check if time is expired
+      # @return [Boolean] is the time expired.
+      def expired?
+        !ttl_in_seconds.nil? && rates_expiration < Time.now
       end
 
       # Source url of CurrencylayerBank
@@ -124,10 +117,17 @@ class Money
       def source_url
         fail NoAccessKey if access_key.nil? || access_key.empty?
         cl_url = CL_URL
-        cl_url = SECURE_CL_URL if secure_connection
+        cl_url = CL_SECURE_URL if secure_connection
         "#{cl_url}?source=#{source}&access_key=#{access_key}"
       end
 
+      # Get the timestamp of rates
+      # @return [Time] Time object or nil
+      def rates_timestamp
+        parsed = raw_rates_careful
+        parsed.key?('timestamp') ? Time.at(parsed['timestamp']) : nil
+      end
+
       protected
 
       # Store the provided text data by calling the proc method provided
@@ -142,13 +142,23 @@ class Money
         if cache.is_a?(Proc)
           cache.call(text)
         elsif cache.is_a?(String)
-          open(cache, 'w') do |f|
-            f.write(text)
-          end
+          write_to_file(text)
+        end
+      end
+
+      # Writes content to file cache
+      # @param text [String] String to cache
+      # @return [String,Integer]
+      def write_to_file(text)
+        open(cache, 'w') do |f|
+          f.write(text)
         end
+      rescue Errno::ENOENT
+        raise InvalidCache
       end
 
       # Read from cache when exist
+      # @return [Proc,String] JSON content
       def read_from_cache
         if cache.is_a?(Proc)
           cache.call(nil)
@@ -157,9 +167,20 @@ class Money
         end
       end
 
-      # Read from url
+      # Get remote content and store in cache
       # @return [String] JSON content
       def read_from_url
+        text = open_url
+        if valid_rates?(text)
+          refresh_rates_expiration!
+          store_in_cache(text) if cache
+        end
+        text
+      end
+
+      # Opens an url and reads the content
+      # @return [String] JSON content
+      def open_url
         open(source_url).read
       end
 
@@ -177,25 +198,42 @@ class Money
         false
       end
 
-      # Get expire rates, first from cache and then from url
+      # Get exchange rates with different strategies
+      #
+      # @example
+      #   exchange_rates(true)
+      #   exchange_rates
+      #
+      # @param [Boolean] true for straight, default is careful
       # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
-      def exchange_rates
-        begin
-          doc = JSON.parse(read_from_cache.to_s)
-        rescue JSON::ParserError
-          begin
-            doc = JSON.parse(read_from_url)
-          rescue JSON::ParserError
-            doc = { 'quotes' => {} }
-          end
+      def exchange_rates(straight = false)
+        if straight
+          @rates = raw_rates_straight['quotes']
+        else
+          @rates = raw_rates_careful['quotes']
         end
-        @cl_rates = doc['quotes']
+      end
+
+      # Get raw exchange rates from cache and then from url
+      # @return [String] JSON content
+      def raw_rates_careful
+        JSON.parse(read_from_cache.to_s)
+      rescue JSON::ParserError
+        raw_rates_straight
+      end
+
+      # Get raw exchange rates from url
+      # @return [String] JSON content
+      def raw_rates_straight
+        JSON.parse(read_from_url)
+      rescue JSON::ParserError
+        { 'quotes' => {} }
       end
 
       # Refresh expiration from now
       # return [Time] new expiration time
-      def refresh_rates_expiration
-        @rates_expiration = Time.now + ttl_in_seconds
+      def refresh_rates_expiration!
+        @rates_expiration = Time.now + ttl_in_seconds unless ttl_in_seconds.nil?
       end
     end
   end

data/test/currencylayer_bank_test.rb

@@ -4,12 +4,12 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 describe Money::Bank::CurrencylayerBank do
   subject { Money::Bank::CurrencylayerBank.new }
   let(:url) { Money::Bank::CurrencylayerBank::CL_URL }
-  let(:secure_url) { Money::Bank::CurrencylayerBank::SECURE_CL_URL }
+  let(:secure_url) { Money::Bank::CurrencylayerBank::CL_SECURE_URL }
   let(:source) { Money::Bank::CurrencylayerBank::CL_SOURCE }
   let(:temp_cache_path) do
     File.expand_path(File.join(File.dirname(__FILE__), 'temp.json'))
   end
-  let(:cache_path) do
+  let(:data_path) do
     File.expand_path(File.join(File.dirname(__FILE__), 'live.json'))
   end
 
@@ -17,8 +17,8 @@ describe Money::Bank::CurrencylayerBank do
     before do
       subject.access_key = TEST_ACCESS_KEY
       subject.cache = temp_cache_path
-      stub(subject).read_from_url { File.read cache_path }
-      subject.save_rates
+      stub(subject).source_url { data_path }
+      subject.update_rates
     end
 
     after do
@@ -61,61 +61,70 @@ describe Money::Bank::CurrencylayerBank do
     end
   end
 
-  describe 'no cache' do
+  describe 'cache rates' do
     before do
-      subject.cache = nil
       subject.access_key = TEST_ACCESS_KEY
-      stub(subject).read_from_url { File.read cache_path }
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+      subject.update_rates
     end
 
-    it 'should get from url' do
-      subject.update_rates
-      subject.cl_rates.wont_be_empty
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
     end
 
-    it 'should raise an error if invalid path is given to save_rates' do
-      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+    it 'should allow update after save' do
+      begin
+        subject.update_rates
+      rescue
+        assert false, 'Should allow updating after saving'
+      end
     end
-  end
 
-  describe '#secure_connection' do
-    it "should use the non-secure http url if secure_connection isn't set" do
-      subject.secure_connection = nil
-      subject.access_key = TEST_ACCESS_KEY
-      subject.source_url.must_equal "#{url}?source=#{source}&"\
-                                    "access_key=#{TEST_ACCESS_KEY}"
+    it 'should not break an existing file if save fails to read' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
     end
 
-    it 'should use the non-secure http url if secure_connection is false' do
-      subject.secure_connection = false
-      subject.access_key = TEST_ACCESS_KEY
-      subject.source_url.must_equal "#{url}?source=#{source}&"\
-                                    "access_key=#{TEST_ACCESS_KEY}"
+    it 'should not break an existing file if save returns json without rates' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '{ "error": "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
     end
 
-    it 'should use the secure https url if secure_connection is set to true' do
-      subject.secure_connection = true
-      subject.access_key = TEST_ACCESS_KEY
-      subject.source_url.must_equal "#{secure_url}?source=#{source}&"\
-                                    "access_key=#{TEST_ACCESS_KEY}"
-      subject.source_url.must_include 'https://'
+    it 'should not break an existing file if save returns a invalid json' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).open_url { '{ invalid_json: "An error" }' }
+      subject.update_rates
+      File.read(temp_cache_path).size.must_equal initial_size
     end
   end
 
-  describe 'no valid file for cache' do
+  describe 'no cache' do
     before do
-      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
+      subject.cache = nil
       subject.access_key = TEST_ACCESS_KEY
-      stub(subject).read_from_url { File.read cache_path }
+      stub(subject).source_url { data_path }
     end
 
     it 'should get from url' do
       subject.update_rates
-      subject.cl_rates.wont_be_empty
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe 'no valid file for cache' do
+    before do
+      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
+      subject.access_key = TEST_ACCESS_KEY
+      stub(subject).source_url { data_path }
     end
 
-    it 'should raise an error if invalid path is given to save_rates' do
-      proc { subject.save_rates }.must_raise Money::Bank::InvalidCache
+    it 'should raise an error if invalid path is given' do
+      proc { subject.update_rates }.must_raise Money::Bank::InvalidCache
     end
   end
 
@@ -133,31 +142,55 @@ describe Money::Bank::CurrencylayerBank do
     end
 
     it 'should get from url normally' do
-      stub(subject).source_url { cache_path }
+      stub(subject).source_url { data_path }
       subject.update_rates
-      subject.cl_rates.wont_be_empty
+      subject.rates.wont_be_empty
     end
 
     it 'should save from url and get from cache' do
-      stub(subject).source_url { cache_path }
-      subject.save_rates
+      stub(subject).source_url { data_path }
+      subject.update_rates
       @global_rates.wont_be_empty
       dont_allow(subject).source_url
       subject.update_rates
-      subject.cl_rates.wont_be_empty
+      subject.rates.wont_be_empty
+    end
+  end
+
+  describe '#secure_connection' do
+    it "should use the non-secure http url if secure_connection isn't set" do
+      subject.secure_connection = nil
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+    end
+
+    it 'should use the non-secure http url if secure_connection is false' do
+      subject.secure_connection = false
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+    end
+
+    it 'should use the secure https url if secure_connection is set to true' do
+      subject.secure_connection = true
+      subject.access_key = TEST_ACCESS_KEY
+      subject.source_url.must_equal "#{secure_url}?source=#{source}&"\
+                                    "access_key=#{TEST_ACCESS_KEY}"
+      subject.source_url.must_include 'https://'
     end
   end
 
   describe '#update_rates' do
     before do
       subject.access_key = TEST_ACCESS_KEY
-      subject.cache = cache_path
-      stub(subject).read_from_url { File.read cache_path }
+      subject.cache = data_path
+      stub(subject).source_url { data_path }
       subject.update_rates
     end
 
     it 'should update itself with exchange rates from CurrencylayerBank' do
-      subject.cl_rates.keys.each do |currency|
+      subject.rates.keys.each do |currency|
         next unless Money::Currency.find(currency)
         subject.get_rate('USD', currency).must_be :>, 0
       end
@@ -203,57 +236,15 @@ describe Money::Bank::CurrencylayerBank do
   describe '#access_key' do
     before do
       subject.cache = temp_cache_path
-      stub(OpenURI::OpenRead).open(url) { File.read cache_path }
+      stub(OpenURI::OpenRead).open(url) { File.read data_path }
     end
 
     it 'should raise an error if no access key is set' do
-      proc { subject.save_rates }.must_raise Money::Bank::NoAccessKey
+      proc { subject.update_rates }.must_raise Money::Bank::NoAccessKey
     end
   end
 
-  describe '#save_rates' do
-    before do
-      subject.access_key = TEST_ACCESS_KEY
-      subject.cache = temp_cache_path
-      stub(subject).read_from_url { File.read cache_path }
-      subject.save_rates
-    end
-
-    it 'should allow update after save' do
-      begin
-        subject.update_rates
-      rescue
-        assert false, 'Should allow updating after saving'
-      end
-    end
-
-    it 'should not break an existing file if save fails to read' do
-      initial_size = File.read(temp_cache_path).size
-      stub(subject).read_from_url { '' }
-      subject.save_rates
-      File.open(temp_cache_path).read.size.must_equal initial_size
-    end
-
-    it 'should not break an existing file if save returns json without rates' do
-      initial_size = File.read(temp_cache_path).size
-      stub(subject).read_from_url { '{ "error": "An error" }' }
-      subject.save_rates
-      File.open(temp_cache_path).read.size.must_equal initial_size
-    end
-
-    it 'should not break an existing file if save returns a invalid json' do
-      initial_size = File.read(temp_cache_path).size
-      stub(subject).read_from_url { '{ invalid_json: "An error" }' }
-      subject.save_rates
-      File.open(temp_cache_path).read.size.must_equal initial_size
-    end
-
-    after do
-      File.delete temp_cache_path
-    end
-  end
-
-  describe '#expire_rates' do
+  describe '#expire_rates!' do
     before do
       subject.access_key = TEST_ACCESS_KEY
       subject.ttl_in_seconds = 1000
@@ -262,12 +253,11 @@ describe Money::Bank::CurrencylayerBank do
       @new_usd_eur_rate = 0.886584
       subject.add_rate('USD', 'EUR', @old_usd_eur_rate)
       subject.cache = temp_cache_path
-      stub(subject).read_from_url { File.read cache_path }
-      subject.save_rates
+      stub(subject).source_url { data_path }
     end
 
     after do
-      File.delete temp_cache_path
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
     end
 
     describe 'when the ttl has expired' do
@@ -282,7 +272,7 @@ describe Money::Bank::CurrencylayerBank do
       it 'updates the next expiration time' do
         Timecop.freeze(Time.now + 1001) do
           exp_time = Time.now + 1000
-          subject.expire_rates
+          subject.expire_rates!
           subject.rates_expiration.must_equal exp_time
         end
       end
@@ -290,10 +280,34 @@ describe Money::Bank::CurrencylayerBank do
 
     describe 'when the ttl has not expired' do
       it 'not should update the rates' do
+        subject.update_rates
         exp_time = subject.rates_expiration
-        subject.expire_rates
+        subject.expire_rates!
         subject.rates_expiration.must_equal exp_time
       end
     end
   end
+
+  describe '#rates_timestamp' do
+    before do
+      subject.access_key = TEST_ACCESS_KEY
+      subject.cache = temp_cache_path
+      stub(subject).source_url { data_path }
+    end
+
+    after do
+      File.delete(temp_cache_path) if File.exist?(temp_cache_path)
+    end
+
+    it 'should return nil if no rates' do
+      stub(subject).open_url { '' }
+      subject.update_rates
+      subject.rates_timestamp.must_be_nil
+    end
+
+    it 'should return a Time object' do
+      subject.update_rates
+      subject.rates_timestamp.class.must_equal Time
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money