money-currencylayer-bank 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34fe15fb5a511798ab01fd6bb0d230505211d985
-  data.tar.gz: 4f9e805357eafdc38f1fca9d4d53164c8f002228
+  metadata.gz: 2954dfb52185c910cfed6a3f3b1def920c80c847
+  data.tar.gz: 408ba3963b1c258ce322e69237c951f34988ba1e
 SHA512:
-  metadata.gz: c2ed1a8ec702c34866295ad35622aa56b469f9a8f8cd13cae5e9e86a43d869b2304f1654639f142b6d15639ed4a17c02a1ff12e08ddefbefba92aab19dfc70b7
-  data.tar.gz: e8f8317e5932cadb8bee5669c978f53604af9fab0ad300558ac6a69b1ce076e2533214148976bd0b90e644842a8bb21d6a5de9a3c4c61086f606c2c1a85a9b67
+  metadata.gz: f1696528b4ac735817a8fc476b1b5a3e87512ce4e167baf36601a794ef6de6a521c0496a05f943e0ca9f643ab2f3a1361f4e5a663d32a4a684df27f1894a62fa
+  data.tar.gz: a58368adeb7bbc501e5ef1e13f55e9deff90084b7b45f9021c1f49b9bb4241b4acfee44303e28f7002efdfc56c230547b98b149c59b3c4bcf34633a597c2e0cc

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Phlegx Systems OG
+Copyright (c) 2016 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

@@ -1,6 +1,7 @@
 # Money Currencylayer Bank
 
 [![Gem Version](https://badge.fury.io/rb/money-currencylayer-bank.svg)](https://rubygems.org/gems/money-currencylayer-bank)
+[![Gem](https://img.shields.io/gem/dt/money-currencylayer-bank.svg?maxAge=2592000)](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)
@@ -40,6 +41,22 @@ See more about Currencylayer product plans on https://currencylayer.com/product.
 * supports caching currency rates
 * calculates every pair rate calculating inverse rate or using base currency rate
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-currencylayer-bank'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-currencylayer-bank
+
 ## Usage
 
 ~~~ ruby

data/lib/money/bank/currencylayer_bank.rb

@@ -26,22 +26,39 @@ class Money
       # Use https to fetch rates from CurrencylayerBank
       # CurrencylayerBank only allows http as connection
       # 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
 
-      # Rates expiration Time
-      attr_reader :rates_expiration
-
       # Parsed CurrencylayerBank result as Hash
       attr_reader :rates
 
-      # Seconds after than the current rates are automatically expired
-      attr_reader :ttl_in_seconds
+      # Set the seconds after than the current rates are automatically expired
+      # by default, they never expire.
+      #
+      # @example
+      #   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
 
       # Set the base currency for all rates. By default, USD is used.
       # CurrencylayerBank only allows USD as base currency
@@ -63,19 +80,11 @@ class Money
         @source ||= CL_SOURCE
       end
 
-      # Set the seconds after than the current rates are automatically expired
+      # Get the seconds after than the current rates are automatically expired
       # by default, they never expire.
-      #
-      # @example
-      #   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
-      def ttl_in_seconds=(value)
-        @ttl_in_seconds = value
-        refresh_rates_expiration!
-        @ttl_in_seconds
+      def ttl_in_seconds
+        @ttl_in_seconds ||= 0
       end
 
       # Update all rates from CurrencylayerBank JSON
@@ -140,7 +149,7 @@ class Money
       # Check if rates are expired
       # @return [Boolean] true if rates are expired
       def expired?
-        rates_expiration ? rates_expiration <= Time.now : true
+        Time.now > rates_expiration
       end
 
       # Source url of CurrencylayerBank
@@ -153,27 +162,21 @@ class Money
         "#{cl_url}?source=#{source}&access_key=#{access_key}"
       end
 
+      # Get rates expiration time based on ttl
+      # @return [Time] rates expiration time
+      def rates_expiration
+        rates_timestamp + ttl_in_seconds
+      end
+
       # Get the timestamp of rates
       # @return [Time] time object or nil
       def rates_timestamp
-        @rates_timestamp ||= init_rates_timestamp
+        raw = raw_rates_careful
+        raw.key?('timestamp') ? Time.at(raw['timestamp']) : Time.at(0)
       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.
       #
@@ -216,10 +219,7 @@ class Money
       # @return [String] unparsed JSON content
       def read_from_url
         text = open_url
-        if valid_rates?(text)
-          refresh_rates_expiration!
-          store_in_cache(text) if cache
-        end
+        store_in_cache(text) if valid_rates?(text) && cache
         text
       end
 
@@ -227,6 +227,8 @@ class Money
       # @return [String] unparsed JSON content
       def open_url
         open(source_url).read
+      rescue OpenURI::HTTPError
+        ''
       end
 
       # Check validity of rates response only for store in cache
@@ -261,26 +263,18 @@ class Money
 
       # Get raw exchange rates from cache and then from url
       # @return [String] JSON content
-      def raw_rates_careful
+      def raw_rates_careful(rescue_straight = true)
         JSON.parse(read_from_cache.to_s)
       rescue JSON::ParserError
-        raw_rates_straight
+        rescue_straight ? raw_rates_straight : { 'quotes' => {} }
       end
 
       # Get raw exchange rates from url
       # @return [String] JSON content
       def raw_rates_straight
-        raw_rates = JSON.parse(read_from_url)
-        init_rates_timestamp(raw_rates)
-        raw_rates
+        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 unless ttl_in_seconds.nil?
+        raw_rates_careful(false)
       end
     end
   end

data/test/currencylayer_bank_test.rb

@@ -230,7 +230,7 @@ describe Money::Bank::CurrencylayerBank do
       subject.access_key = TEST_ACCESS_KEY
       subject.ttl_in_seconds = 1000
       @old_usd_eur_rate = 0.655
-      # see test/latest.json +54
+      # 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
@@ -243,16 +243,18 @@ describe Money::Bank::CurrencylayerBank do
 
     describe 'when the ttl has expired' do
       it 'should update the rates' do
-        subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
-        Timecop.freeze(Time.now + 1001) do
+        Timecop.freeze(subject.rates_timestamp + 1000) do
+          subject.get_rate('USD', 'EUR').must_equal @old_usd_eur_rate
+        end
+        Timecop.freeze(subject.rates_timestamp + 1001) do
           subject.get_rate('USD', 'EUR').wont_equal @old_usd_eur_rate
           subject.get_rate('USD', 'EUR').must_equal @new_usd_eur_rate
         end
       end
 
       it 'updates the next expiration time' do
-        Timecop.freeze(Time.now + 1001) do
-          exp_time = Time.now + 1000
+        Timecop.freeze(subject.rates_timestamp + 1001) do
+          exp_time = subject.rates_timestamp + 1000
           subject.expire_rates!
           subject.rates_expiration.must_equal exp_time
         end
@@ -280,10 +282,10 @@ describe Money::Bank::CurrencylayerBank do
       File.delete(temp_cache_path) if File.exist?(temp_cache_path)
     end
 
-    it 'should return nil if no rates' do
+    it 'should return 1970-01-01 datetime if no rates' do
       stub(subject).open_url { '' }
       subject.update_rates
-      subject.rates_timestamp.must_be_nil
+      subject.rates_timestamp.must_equal Time.at(0)
     end
 
     it 'should return a Time object' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-currencylayer-bank
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Egon Zemmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -98,30 +98,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,16 @@ dependencies:
   name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 description: A gem that calculates the exchange rate using published rates from currencylayer.com.
   Compatible with the money gem.
 email: office@phlegx.com