money-ecb 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTJmZTg5YTgzNDFjOGI5ZjVmNmI4NGMzMzg3MGRiNzJmYTM3NGMyZQ==
+    ZDRiZDk3M2U0MmVmNjM1ZTUzMTAzMDhlZjY3OWU4MzEyNGNiMDYzZQ==
   data.tar.gz: !binary |-
-    NGIwZjA4OTkxYTkwNjZhNjBkZWYwZTExYzdhMjg0NTJmZWM4MWRmMw==
+    MjExZmM4NDQwNjBhYTQ4OGRkNzM4MjQ0YzcyOTNlMWQ4OWQ1MWFkNA==
 SHA512:
   metadata.gz: !binary |-
-    ZGJhZjMwOTRiZTI1YjhkYTBmNTcyY2M2NDAwYjY5OThhZmRkMjg3OTA5YTE4
-    MjBkNGNhZGU1MTQyMWY2ZjliOThlY2Y5YTE0NjExYWU3MzM2OTU5YWZhNWY4
-    ZTg2NGQxNTc4YWQ0MTQyMDEwODE0MDhhOWJjYmI1OTM4OGE3ZjQ=
+    NDg0Y2ViNzdmYzY5MTk2MzVmZTc3NTU1MmMwZThlZDdhZDdlMjYzODE0NzU4
+    NDUzOWJkMGUxNGQwZjg2NjgwYmE4ZDAzOWM2YmQ5ZjIzYjdkMzhmNDljY2Fk
+    ODIyOWQ5OWFiNWZhNjUxZmQ1OTI2MTA4ZmEzMWIxN2E1NjU5ZWI=
   data.tar.gz: !binary |-
-    OThmOTk0ZThmMWI1YzFkYmVlZWFiNTE2YjFkY2QyNjUyZTUyY2NiOGE4ZjA4
-    Y2Q4OGY4ZGIwYmQ0OGYwZjdlZGMyZjI4MDk5ZGM2NGJjYzE5YmY2YTM0YjQ4
-    Yzc5NGNhMGJjMGJlMWU5NmI3ODZjMmMxNjgwNDFlYWJkNTdiNmI=
+    YjkxODk1NWY1ODNmYjBlYzM4NWUwOTJiMjRmZGU5Y2UwZjlkYjk1NmQ0Yzky
+    YmYyY2RiYjE5OTk3MjcwOTE1YzQ2OGRjMDk2NDBiMzFhYjFhMjU4NWQwYjVk
+    YTc2ZDJkODU2YzJhMmI4Y2MzY2I1ZGYxYzUwZDZiNDg0YWQ2Mjg=

data/.gitignore

@@ -1,3 +1,4 @@
 *.swp
 .bundle
 money-ecb-*.gem
+.yardoc

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    monetize (0.1.4)
+    money (6.0.1)
+      i18n (~> 0.6.4)
+      monetize (~> 0.1.3)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    rubyzip (1.1.0)
+    slop (3.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  money
+  pry
+  rake
+  rspec
+  rubyzip

data/README.rst

@@ -56,16 +56,10 @@ Using ``money`` and ``monetize``:
     require 'money/bank/ecb'
     require 'monetize/core_extensions'
 
-    Money.default_bank = Money::Bank::ECB.new('/tmp/ecb.cache')
+    Money.default_bank = Money::Bank::ECB.new
 
     puts '1 EUR'.to_money.exchange_to(:USD)
 
-If ``/tmp/ecb.cache`` is a valid CSV file with exchange rates, the rates will be
-used for conversion (unless newer rates are available; if so, new rates will be
-fetched—see `auto-update`_). If the file does not exist or is "somehow bogus",
-new rates will be downloaded from the European Central Bank and stored in the
-file.
-
 
 Rounding
 --------
@@ -81,7 +75,19 @@ creating the ``ECB`` instance:
 
 .. code-block:: ruby
 
-    Money.default_bank = Money::Bank::ECB.new('/tmp/ecb.cache') {|x| x.round}
+    Money.default_bank = Money::Bank::ECB.new {|x| x.round}
+
+Local cache file
+----------------
+
+For your convenience, :ruby:`.new` will accept a string representing a file
+path.
+
+If the file path holds a valid CSV file with exchange rates, the rates will be
+used for conversion (unless newer rates are available; if so, new rates will be
+fetched—see `auto-update`_). If the file does not exist or is "somehow bogus",
+new rates will be downloaded from the European Central Bank and stored in the
+file (or an :ruby:`InvalidCacheError` will be raise if `auto-update`_ is off).
 
 
 .. _`auto-update`:
@@ -92,12 +98,24 @@ Auto-update rates
 The European Central Bank publishes foreign exchange rates daily, and they
 should be available at 14:00 CE(S)T. The cache is automatically updated when
 doing an exchange after new rates has been published; to disable this, set
-:ruby:`Money::Bank::ECB#auto_update = false`.
+:ruby:`#auto_update = false`; to force, :ruby:`#update_cache` and
+:ruby:`#reload` (or both in one take, :ruby:`#update`).
+
+Also notice that when instantiating an :ruby:`ECB`, rates will be loaded from
+the cache file, and if that fails, new rates will be fetched automatically. So
+if you want to handle updating rates "by hand", you should place a valid cache
+before :ruby:`.new` and then call :ruby:`#reload` after you updated the cache.
+
+.. _`Can I code my own cache?`:
+
+Can I code my own cache?
+------------------------
 
-Also notice that when instantiating an ``ECB`` rates will be loaded from the
-cache file, and if that fails, new rates will be fetched automatically. So if
-you want to handle updating rates "by hand", you should place a valid cache
-before ``ECB.new`` and then call ``#reload`` after you updated the cache.
+Yes, just :ruby:`include Money::Bank::ECB::Cache` and implement
+:ruby:`.new_from?` (if you accept what :ruby:`.new` was given) and
+:ruby:`.priority` (let it be ``=> 2`` since ``0`` and ``1`` are already used for
+:ruby:`SimpleCache` and :ruby:`CacheFile` respectively). No monkey patching
+needed!
 
 
 Contribute

data/lib/money/bank/ecb/cache.rb

@@ -0,0 +1,22 @@
+class Money
+  module Bank
+    class ECB < Money::Bank::VariableExchange
+      module Cache
+        # Set the cache.
+        #
+        # @param [String] value Set the cache to hold the value.
+        # @return [String]
+        def set(value)
+          raise StandardError, "Implement '.set(&block)' in your Cache!"
+        end
+
+        # Get what the cache contains.
+        #
+        # @return [String]
+        def get
+          raise StandardError, "Implement '.get' in your Cache!"
+        end
+      end
+    end
+  end
+end

data/lib/money/bank/ecb/cache_file.rb

@@ -0,0 +1,23 @@
+class Money
+  module Bank
+    class ECB < Money::Bank::VariableExchange
+      class CacheFile
+        include Cache
+
+        def initialize(path)
+          @path = path
+        end
+        attr_reader :path
+
+        def set(value)
+          File.write(@path, value)
+          value
+        end
+
+        def get
+          File.read(@path)
+        end
+      end
+    end
+  end
+end

data/lib/money/bank/ecb/simple_cache.rb

@@ -0,0 +1,17 @@
+class Money
+  module Bank
+    class ECB < Money::Bank::VariableExchange
+      class SimpleCache
+        include Cache
+
+        def set(value)
+          @content = value
+        end
+
+        def get
+          @content
+        end
+      end
+    end
+  end
+end

data/lib/money/bank/ecb.rb

@@ -5,6 +5,11 @@ require 'bigdecimal'
 require 'zip'
 require 'csv'
 
+# Cache require order is important!
+require 'money/bank/ecb/cache'
+require 'money/bank/ecb/simple_cache'
+require 'money/bank/ecb/cache_file'
+
 class Money
   module Bank
     # This class represents the European Central Bank or more precisely, its
@@ -14,16 +19,12 @@ class Money
     #   The available currencies to exchange between.
     #   @return [Array<String>]
     #
-    # @!attribute [r] rounding_method
-    #   The default rounding method for the bank.
-    #   @return [Proc]
-    #
     # @!attribute [rw] auto_update
     #   Auto-updating on or off.
     #   @param [true,false] bool
     #   @return [true,false]
     #
-    # @!attribute [r] cache_filename
+    # @!attribute [r] cache
     #   The cache path and file name
     #   @return[String]
     #
@@ -47,22 +48,36 @@ class Money
       # @return [Money::Bank::ECB]
       #
       # @example
-      #   Money::Bank::ECB.new('/tmp/ecb.cache') {|x| x.floor}
+      #   Money::Bank::ECB.new {|x| x.floor}
       #   #=> #<Money::Bank::ECB
-      #         @cache_filename='/tmp/ecb.cache',
       #         @rounding_method=#<Proc>,
       #         @auto_update=true,
       #         @rates=#<Hash>,
       #         @rates_date=#<Time>,
       #         @currencies=#<Array>>
-      def initialize(cache_filename, &rounding_method)
-        @cache_filename  = cache_filename
-        @rounding_method = rounding_method
+      def initialize(cache = nil, &rounding_method)
+        @cache = self.class.build(cache)
+        super(&rounding_method)
+
         setup
       end
 
-      attr_reader :cache_filename
-      attr_reader :rounding_method
+      # Builds a Cache from input.
+      #
+      # @param [*] something The thing to build a Cache from.
+      # @return [Cache]
+      def self.build(cache)
+        case cache
+        when Money::Bank::ECB::Cache
+          cache
+        when String
+          Money::Bank::ECB::CacheFile.new(cache)
+        else
+          Money::Bank::ECB::SimpleCache.new
+        end
+      end
+
+      attr_reader :cache
       attr_accessor :auto_update
 
       # Setup rates hash, mutex for rates locking, and auto_update default.
@@ -86,7 +101,6 @@ class Money
       #
       # @example
       #   ecb.exchange_with(Money.new(100, :EUR), :USD)
-      #   #=> #<Money
       def exchange_with(from, to, &rounding_method)
         update if @auto_update and Time.now.utc > (@rates_date + 60*60*24)
         super(from, to, &rounding_method)
@@ -108,11 +122,9 @@ class Money
       #
       # @return [self]
       def update_cache
-        File.open(@cache_filename, 'w') do |cache_file|
-          Zip::InputStream.open(open(RATES_URL)) do |io|
-            io.get_next_entry
-            cache_file.puts(io.read)
-          end
+        Zip::InputStream.open(open(RATES_URL)) do |io|
+          io.get_next_entry
+          @cache.set(io.read)
         end
 
         self
@@ -132,17 +144,19 @@ class Money
 
         @mutex.synchronize do
           @rates_date = time
-          @currencies = quotations.keys
+          @currencies = quotations.map{|key, _| key}
 
           quotations.each do |currency, rate|
             set_rate('EUR', currency, rate, :without_mutex => true)
             set_rate(currency, 'EUR', 1/rate, :without_mutex => true)
+          end
 
-            quotations.each do |other_currency, other_rate|
-              next if currency == other_currency
+          quotations.product(quotations) do |one, another|
+            one_cur, one_rate = one
+            another_cur, another_rate = another
+            next if one_cur == another_cur
 
-              set_rate(currency, other_currency, other_rate/rate, :without_mutex => true)
-            end
+            set_rate(one_cur, another_cur, another_rate/one_rate, :without_mutex => true)
           end
         end
 
@@ -155,17 +169,18 @@ class Money
       #
       # @return [[Time, Hash]]
       def cache_content
-        csv = CSV.parse(File.open(@cache_filename).read, :headers => true)
+        csv = CSV.parse(@cache.get, :headers => true)
         csv = csv.first # Only one line.
 
         # Clean-up
-        hash = Hash[csv.map{|x,y| [x.strip, y.strip]}]
-        hash.delete('')
+        csv = csv.map{|key, value| [key.strip, value.strip]}
+                 .delete_if{|key, _| key.empty?}
 
-        date = hash.delete('Date')
+        date_entry, *quotations = *csv
+        _, date = date_entry
 
         time = Time.parse(date + ' ' + self.class.new_rates_time_of_day_s(date))
-        quotations = Hash[hash.map{|cur,rate| [cur, BigDecimal.new(rate)]}]
+        quotations.map!{|cur,rate| [cur, BigDecimal.new(rate)]}
 
         [time, quotations]
       rescue

data/money-ecb.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'money-ecb'
-  s.version     = '0.0.2'
+  s.version     = '0.1.0'
   s.summary     = 'Foreign exchange rates from the EU Central Bank (ECB).'
   s.description = 'A Money::Bank that will fetch foreign exchange rates from the EU Central Bank (ECB).'
   s.license     = 'MIT'

data/spec/ecb/cache_spec.rb

@@ -0,0 +1,22 @@
+require 'securerandom'
+require 'tempfile'
+
+describe 'Money::Bank::ECB::SimpleCache' do
+  it 'should respect the set/get interface' do
+    c = Money::Bank::ECB::SimpleCache.new
+    random = SecureRandom.urlsafe_base64(10)
+
+    expect(c.set(random)).to eq(random)
+    expect(c.get).to eq(random)
+  end
+end
+
+describe 'Money::Bank::ECB::CacheFile' do
+  it 'should respect the set/get interface' do
+    c = Money::Bank::ECB::CacheFile.new(Tempfile.new('money-ecb-spec').path)
+    random = SecureRandom.urlsafe_base64(10)
+
+    expect(c.set(random)).to eq(random)
+    expect(c.get).to eq(random)
+  end
+end

data/spec/ecb_spec.rb

@@ -1,13 +1,17 @@
 require 'money/bank/ecb'
 require_relative 'support/custom_expectations/write_expectation'
 
-describe 'ECB' do
+describe 'Money::Bank::ECB' do
   before do
     @assetsdir = File.dirname(__FILE__) + '/assets'
     @tmpdir = File.dirname(__FILE__) + '/tmp'
     %x{cp -r #{@assetsdir} #{@tmpdir}}
   end
 
+  after do
+    %x{rm -rf #{@tmpdir}}
+  end
+
   let(:bank) do
     bank = Money::Bank::ECB.new(@tmpdir + '/good_rates.csv')
     bank.auto_update = false
@@ -15,8 +19,65 @@ describe 'ECB' do
     bank
   end
 
-  after do
-    %x{rm -rf #{@tmpdir}}
+  describe '#new' do
+    let(:good_rates) do
+      {
+        'USD' => 1.3574,  'JPY' => 139.28,   'BGN' => 1.9558,  'CZK' => 27.594,
+        'DKK' => 7.4622,  'GBP' => 0.82380,  'HUF' => 310.97,  'LTL' => 3.4528,
+        'PLN' => 4.2312,  'RON' => 4.5110,   'SEK' => 8.8347,  'CHF' => 1.2233,
+        'NOK' => 8.4680,  'HRK' => 7.6605,   'RUB' => 47.8025, 'TRY' => 3.0808,
+        'AUD' => 1.5459,  'BRL' => 3.2955,   'CAD' => 1.5176,  'CNY' => 8.2302,
+        'HKD' => 10.5421, 'IDR' => 16551.39, 'INR' => 85.0840, 'KRW' => 1469.53,
+        'MXN' => 18.1111, 'MYR' => 4.5417,   'NZD' => 1.6624,  'PHP' => 61.527,
+        'SGD' => 1.7323,  'THB' => 44.745,   'ZAR' => 15.2700, 'ILS' => 4.7416,
+      }
+    end
+
+    context 'when no cache is given' do
+      it 'should fetch rates and store in mem' do
+        expect{
+          Money::Bank::ECB::RATES_URL = File.expand_path(@tmpdir + '/eurofxref.zip')
+        }.to write(/warning: already initialized constant .*RATES_URL/).to(:stderr)
+
+        bank = Money::Bank::ECB.new
+        expect(bank.cache).to be_a(Money::Bank::ECB::SimpleCache)
+      end
+    end
+
+    context 'when cache file path is given' do
+      it 'should use the file path as a cache' do
+        expect(bank.cache).to be_a(Money::Bank::ECB::CacheFile)
+      end
+    end
+
+    context 'when cache file is good' do
+      it 'should use rates from cache' do
+        expect(bank.rates_date).to eq(Time.utc(2014, 01, 30, 14))
+        bank.currencies.each do |cur|
+          expect(bank.rates['EUR_TO_' + cur]).to eq(good_rates[cur])
+        end
+      end
+    end
+
+    context 'when cache file is bogus' do
+      it 'should fetch rates from ECB' do
+        expect{
+          Money::Bank::ECB::RATES_URL = File.expand_path(@tmpdir + '/eurofxref.zip')
+        }.to write(/warning: already initialized constant .*RATES_URL/).to(:stderr)
+
+        bogus = Money::Bank::ECB.new(@tmpdir + '/bogus_rates.csv')
+        bogus.auto_update = false
+
+        expect(bogus.rates_date).to eq(Time.utc(2014, 01, 31, 14))
+      end
+    end
+
+    context 'when a rounding method is given' do
+      it 'rounding method should be used' do
+        weird = Money::Bank::ECB.new(@tmpdir + '/good_rates.csv') {|x| 5}
+        expect(weird.exchange_with(Money.new(100, :EUR), :USD)).to eq(Money.new(5, :USD))
+      end
+    end
   end
 
   describe '#currencies' do
@@ -25,6 +86,8 @@ describe 'ECB' do
     it 'should have 32 currencies' do
       expect(currencies.length).to eq(32)
     end
+
+    it { expect(currencies).to include('USD', 'DKK', 'SEK', 'NOK', 'GBP') }
   end
 
   describe '#exchange_with' do
@@ -79,7 +142,7 @@ describe 'ECB' do
           rate = good_rates[to_cur]/good_rates[from_cur]
           to_cents = factor * Money::Currency.wrap(to_cur).subunit_to_unit * rate
 
-          expect(fx(from_cents, from_cur, to_cur).cents).to eq(to_cents.floor) rescue binding.pry
+          expect(fx(from_cents, from_cur, to_cur).cents).to eq(to_cents.floor)
         end
       end
     end
@@ -106,48 +169,9 @@ describe 'ECB' do
     end
   end
 
-  describe '#new' do
-    before(:each) { bank.auto_update = false }
-
-    let(:good_rates) do
-      {
-        'USD' => 1.3574,  'JPY' => 139.28,   'BGN' => 1.9558,  'CZK' => 27.594,
-        'DKK' => 7.4622,  'GBP' => 0.82380,  'HUF' => 310.97,  'LTL' => 3.4528,
-        'PLN' => 4.2312,  'RON' => 4.5110,   'SEK' => 8.8347,  'CHF' => 1.2233,
-        'NOK' => 8.4680,  'HRK' => 7.6605,   'RUB' => 47.8025, 'TRY' => 3.0808,
-        'AUD' => 1.5459,  'BRL' => 3.2955,   'CAD' => 1.5176,  'CNY' => 8.2302,
-        'HKD' => 10.5421, 'IDR' => 16551.39, 'INR' => 85.0840, 'KRW' => 1469.53,
-        'MXN' => 18.1111, 'MYR' => 4.5417,   'NZD' => 1.6624,  'PHP' => 61.527,
-        'SGD' => 1.7323,  'THB' => 44.745,   'ZAR' => 15.2700, 'ILS' => 4.7416,
-      }
-    end
-
-    context 'when cache file is good' do
-      it 'should use rates from cache' do
-        expect(bank.rates_date).to eq(Time.utc(2014, 01, 30, 14))
-        bank.currencies.each do |cur|
-          expect(bank.rates['EUR_TO_' + cur]).to eq(good_rates[cur])
-        end
-      end
-    end
-
-    context 'when cache file is bogus' do
-      it 'should fetch rates from ECB' do
-        expect{
-          Money::Bank::ECB::RATES_URL = File.expand_path(@tmpdir + '/eurofxref.zip')
-        }.to write(/warning: already initialized constant .*RATES_URL/).to(:stderr)
-
-        bogus = Money::Bank::ECB.new(@tmpdir + '/bogus_rates.csv')
-        bogus.auto_update = false
-
-        expect(bogus.rates_date).to eq(Time.utc(2014, 01, 31, 14))
-      end
-    end
-  end
-
   describe '#auto_update' do
     it 'should be on by default' do
-      expect(Money::Bank::ECB.new(@tmpdir + '/good_rates.csv').auto_update).to be_true
+      expect(Money::Bank::ECB.new(Money::Bank::ECB::CacheFile.new(@tmpdir + '/good_rates.csv')).auto_update).to be_true
     end
   end
 
@@ -158,8 +182,8 @@ describe 'ECB' do
 
         expect(time).to be_a(Time)
         expect(time).to eq(Time.utc(2014, 1, 30, 14))
-        expect(quotations).to be_a(Hash)
-        expect(quotations.keys).to include('USD', 'DKK', 'JPY', 'ILS')
+        expect(quotations).to be_a(Array)
+        expect(quotations.map{|key,_| key}).to include('USD', 'DKK', 'JPY', 'ILS')
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-ecb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Casper Thomsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -60,13 +60,18 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
+- Gemfile.lock
 - README.rst
 - Rakefile
 - lib/money/bank/ecb.rb
+- lib/money/bank/ecb/cache.rb
+- lib/money/bank/ecb/cache_file.rb
+- lib/money/bank/ecb/simple_cache.rb
 - money-ecb.gemspec
 - spec/assets/bogus_rates.csv
 - spec/assets/eurofxref.zip
 - spec/assets/good_rates.csv
+- spec/ecb/cache_spec.rb
 - spec/ecb_spec.rb
 - spec/support/custom_expectations/write_expectation.rb
 homepage: https://github.com/ct-clearhaus/money-ecb