money-currencylayer-bank 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f30609c06313fb218edbad89627da0d1bb7bc66d
-  data.tar.gz: 8a1ffe4d046a32e3942b67cf89977ef3d8c2c0f5
+  metadata.gz: 34fe15fb5a511798ab01fd6bb0d230505211d985
+  data.tar.gz: 4f9e805357eafdc38f1fca9d4d53164c8f002228
 SHA512:
-  metadata.gz: 546c3541ae100259af247726d04e17fdb8e86a011e19d3f8d378f8eef8d373f11f3479a703f68876d38a82bfdbf8a26784e25009d7b51178dfea0b07b14e8418
-  data.tar.gz: 11ccf7440dbf5d076578cce0e6cc591c70217ec5481c97caa2f1a32bc4ab03cdffe35fcbbf7a8193151f2687ca512c83e683b44deee1eb0200b36b53be6d4f66
+  metadata.gz: c2ed1a8ec702c34866295ad35622aa56b469f9a8f8cd13cae5e9e86a43d869b2304f1654639f142b6d15639ed4a17c02a1ff12e08ddefbefba92aab19dfc70b7
+  data.tar.gz: e8f8317e5932cadb8bee5669c978f53604af9fab0ad300558ac6a69b1ce076e2533214148976bd0b90e644842a8bb21d6a5de9a3c4c61086f606c2c1a85a9b67

data/Gemfile

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

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/money-currencylayer-bank.svg)](https://rubygems.org/gems/money-currencylayer-bank)
 [![Build Status](https://secure.travis-ci.org/phlegx/money-currencylayer-bank.svg?branch=master)](https://travis-ci.org/phlegx/money-currencylayer-bank)
 [![Code Climate](http://img.shields.io/codeclimate/github/phlegx/money-currencylayer-bank.svg)](https://codeclimate.com/github/phlegx/money-currencylayer-bank)
-[![Inline docs](http://inch-ci.org/github/phlegx/money-currencylayer-bank.svg?branch=master)](http://inch-ci.org/github/phlegx/money-currencylayer-bank)
+[![Inline Docs](http://inch-ci.org/github/phlegx/money-currencylayer-bank.svg?branch=master)](http://inch-ci.org/github/phlegx/money-currencylayer-bank)
+[![Dependency Status](https://gemnasium.com/phlegx/money-currencylayer-bank.svg)](https://gemnasium.com/phlegx/money-currencylayer-bank)
 [![License](https://img.shields.io/github/license/phlegx/money-currencylayer-bank.svg)](http://opensource.org/licenses/MIT)
 
 A gem that calculates the exchange rate using published rates from
@@ -47,11 +48,11 @@ require 'money/bank/currencylayer_bank'
 mclb = Money::Bank::CurrencylayerBank.new
 mclb.access_key = 'your access_key from https://currencylayer.com/product'
 
-# Update rates
+# Update rates (get new rates from remote if expired or access rates from cache)
 mclb.update_rates
 
-# Store in cache
-mclb.save_rates
+# Force update rates from remote and store in cache
+# mclb.update_rates(true)
 
 # (optional)
 # Set the base currency for all rates. By default, USD is used.
@@ -68,7 +69,7 @@ mclb.ttl_in_seconds = 86400
 # CurrencylayerBank only allows http as connection for the free plan users.
 mclb.secure_connection = true
 
-# Define cache
+# Define cache (string or pathname)
 mclb.cache = 'path/to/file/cache'
 
 # Set money default bank to currencylayer bank

data/lib/money/bank/currencylayer_bank.rb

@@ -17,11 +17,11 @@ class Money
     # rubocop:disable Metrics/ClassLength
     class CurrencylayerBank < Money::Bank::VariableExchange
       # CurrencylayerBank url
-      CL_URL = 'http://apilayer.net/api/live'
+      CL_URL = 'http://apilayer.net/api/live'.freeze
       # CurrencylayerBank secure url
-      CL_SECURE_URL = CL_URL.gsub('http:', 'https:')
+      CL_SECURE_URL = CL_URL.gsub('http:', 'https:').freeze
       # Default base currency
-      CL_SOURCE = 'USD'
+      CL_SOURCE = 'USD'.freeze
 
       # Use https to fetch rates from CurrencylayerBank
       # CurrencylayerBank only allows http as connection
@@ -74,7 +74,7 @@ class Money
       # @return [Integer] chosen time to live in seconds
       def ttl_in_seconds=(value)
         @ttl_in_seconds = value
-        refresh_rates_expiration! if ttl_in_seconds
+        refresh_rates_expiration!
         @ttl_in_seconds
       end
 
@@ -140,14 +140,14 @@ class Money
       # Check if rates are expired
       # @return [Boolean] true if rates are expired
       def expired?
-        !ttl_in_seconds.nil? && rates_expiration <= Time.now
+        rates_expiration ? rates_expiration <= Time.now : true
       end
 
       # Source url of CurrencylayerBank
       # defined with access_key and secure_connection
       # @return [String] the remote API url
       def source_url
-        fail NoAccessKey if access_key.nil? || access_key.empty?
+        raise NoAccessKey if access_key.nil? || access_key.empty?
         cl_url = CL_URL
         cl_url = CL_SECURE_URL if secure_connection
         "#{cl_url}?source=#{source}&access_key=#{access_key}"
@@ -156,30 +156,42 @@ class Money
       # 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
+        @rates_timestamp ||= init_rates_timestamp
       end
 
       protected
 
+      # Sets the rates timestamp from parsed JSON content
+      #
+      # @example
+      #   set_rates_timestamp("{\"timestamp\": 1441049528,
+      #                         \"quotes\": {\"USDAED\": 3.67304}}")
+      #
+      # @param raw_rates [String] parsed JSON content, default is nil
+      # @return [Time] time object with rates timestamp
+      def init_rates_timestamp(raw_rates = nil)
+        raw = raw_rates || raw_rates_careful
+        @rates_timestamp = Time.at(raw['timestamp']) if raw.key?('timestamp')
+      end
+
       # Store the provided text data by calling the proc method provided
       # for the cache, or write to the cache file.
       #
       # @example
       #   store_in_cache("{\"quotes\": {\"USDAED\": 3.67304}}")
       #
-      # @param text [String] unparsed JSON content
+      # @param text [String] parsed JSON content
       # @return [String,Integer]
       def store_in_cache(text)
         if cache.is_a?(Proc)
           cache.call(text)
-        elsif cache.is_a?(String)
+        elsif cache.is_a?(String) || cache.is_a?(Pathname)
           write_to_file(text)
         end
       end
 
       # Writes content to file cache
-      # @param text [String] unparsed JSON content
+      # @param text [String] parsed JSON content
       # @return [String,Integer]
       def write_to_file(text)
         open(cache, 'w') do |f|
@@ -190,17 +202,18 @@ class Money
       end
 
       # Read from cache when exist
-      # @return [Proc,String] unparsed JSON content
+      # @return [Proc,String] parsed JSON content
       def read_from_cache
         if cache.is_a?(Proc)
           cache.call(nil)
-        elsif cache.is_a?(String) && File.exist?(cache)
+        elsif (cache.is_a?(String) || cache.is_a?(Pathname)) &&
+              File.exist?(cache)
           open(cache).read
         end
       end
 
       # Get remote content and store in cache
-      # @return [String] JSON content
+      # @return [String] unparsed JSON content
       def read_from_url
         text = open_url
         if valid_rates?(text)
@@ -211,7 +224,7 @@ class Money
       end
 
       # Opens an url and reads the content
-      # @return [String] JSON content
+      # @return [String] unparsed JSON content
       def open_url
         open(source_url).read
       end
@@ -236,14 +249,14 @@ class Money
       #   exchange_rates(true)
       #   exchange_rates
       #
-      # @param [Boolean] true for straight, default is careful
+      # @param straight [Boolean] true for straight, default is careful
       # @return [Hash] key is country code (ISO 3166-1 alpha-3) value Float
       def exchange_rates(straight = false)
-        if straight
-          @rates = raw_rates_straight['quotes']
-        else
-          @rates = raw_rates_careful['quotes']
-        end
+        @rates = if straight
+                   raw_rates_straight['quotes']
+                 else
+                   raw_rates_careful['quotes']
+                 end
       end
 
       # Get raw exchange rates from cache and then from url
@@ -257,7 +270,9 @@ class Money
       # Get raw exchange rates from url
       # @return [String] JSON content
       def raw_rates_straight
-        JSON.parse(read_from_url)
+        raw_rates = JSON.parse(read_from_url)
+        init_rates_timestamp(raw_rates)
+        raw_rates
       rescue JSON::ParserError
         { 'quotes' => {} }
       end

data/test/currencylayer_bank_test.rb

@@ -212,25 +212,6 @@ describe Money::Bank::CurrencylayerBank do
       subject.add_rate('WTF', 'USD', 2)
       subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
     end
-
-    # in response to #4
-    it 'should exchange btc' do
-      btc = {
-        priority: 1,
-        iso_code: 'BTC',
-        name: 'Bitcoin',
-        symbol: 'BTC',
-        subunit: 'Cent',
-        subunit_to_unit: 1000,
-        separator: '.',
-        delimiter: ','
-      }
-      Money::Currency.register(btc)
-      rate = 13.7603
-      subject.add_rate('USD', 'BTC', 1 / 13.7603)
-      subject.add_rate('BTC', 'USD', rate)
-      subject.exchange_with(100.to_money('BTC'), 'USD').cents.must_equal 137_603
-    end
   end
 
   describe '#access_key' do

data/test/test_helper.rb

@@ -10,6 +10,6 @@ TEST_ACCESS_KEY_PATH = File.join(File.dirname(__FILE__), 'TEST_ACCESS_KEY')
 TEST_ACCESS_KEY = ENV['TEST_ACCESS_KEY'] || File.read(TEST_ACCESS_KEY_PATH)
 
 if TEST_ACCESS_KEY.nil? || TEST_ACCESS_KEY.empty?
-  fail "Please add a valid access key to file #{TEST_ACCESS_KEY_PATH} or to " \
-    ' TEST_TEST_ACCESS_KEY environment'
+  raise "Please add a valid access key to file #{TEST_ACCESS_KEY_PATH} or to " \
+    ' TEST_ACCESS_KEY environment'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2016-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.6'
+        version: '6.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.6'
+        version: '6.7'
 - !ruby/object:Gem::Dependency
   name: monetize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
@@ -112,28 +98,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -142,26 +128,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.37.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.37.2
 - !ruby/object:Gem::Dependency
   name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A gem that calculates the exchange rate using published rates from currencylayer.com.