money-open-exchange-rates 0.0.7 → 0.1.1

data/README.markdown

@@ -1,6 +1,7 @@
 # Money Open Exchange Rates
 
-A gem that calculates the exchange rate using published rates from [open-exchange-rates](http://josscrowcroft.github.com/open-exchange-rates/)
+A gem that calculates the exchange rate using published rates from
+[open-exchange-rates](http://josscrowcroft.github.com/open-exchange-rates/)
 
 ## Usage
 
@@ -8,14 +9,33 @@ A gem that calculates the exchange rate using published rates from [open-exchang
 require 'money/bank/open_exchange_rates_bank'
 moe = Money::Bank::OpenExchangeRatesBank.new
 moe.cache = 'path/to/file/cache'
+moe.app_id = 'your app id from https://openexchangerates.org/signup'
 moe.update_rates
 
 Money.default_bank = moe
 ```
 
+You can also provide a Proc as a cache to provide your own caching mechanism
+perhaps with Redis or just a thread safe `Hash` (global). For example:
+
+```ruby
+moe.cache = Proc.new do |v|
+  key = 'money:exchange_rates']
+  if v
+    Thread.current[key] = v
+  else
+    Thread.current[key]
+  end
+end
+```
+
 ## Tests
 
-  bundle exec ruby test/open_exchange_rates_bank_test.rb
+As of the end of August 2012 all requests to the Open Exchange Rates API must
+have a valid app_id. You can place your own key on a file named TEST_APP_ID and
+then run:
+
+  ```bundle exec ruby test/open_exchange_rates_bank_test.rb```
 
 ## Refs
 
@@ -31,6 +51,7 @@ Money.default_bank = moe
 * [Kevin Ball](https://github.com/kball)
 * [Michael Morris](https://github.com/mtcmorris)
 
+
 ## License
 The MIT License
 

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -1,18 +1,20 @@
 # encoding: UTF-8
 require 'open-uri'
-require 'yajl'
+require 'multi_json'
 require 'money'
 
 class Money
   module Bank
     class InvalidCache < StandardError ; end
 
+    class NoAppId < StandardError ; end
+
     class OpenExchangeRatesBank < Money::Bank::VariableExchange
 
       OER_URL = 'http://openexchangerates.org/latest.json'
 
-      attr_accessor :cache
-      attr_reader :doc, :oer_rates, :rates_source
+      attr_accessor :cache, :app_id
+      attr_reader :doc, :oer_rates
 
       def update_rates
         exchange_rates.each do |exchange_rate|
@@ -23,25 +25,11 @@ class Money
         end
       end
 
-      def read_from_url
-        open(OER_URL).read
-      end
-
-      def has_valid_rates?(text)
-        parsed = Yajl::Parser.parse(text)
-        parsed && parsed.has_key?('rates')
-      rescue Yajl::ParseError
-        false
-      end
-
-
       def save_rates
         raise InvalidCache unless cache
-        new_text = read_from_url
-        if has_valid_rates?(new_text)
-          open(cache, 'w') do |f|
-            f.write(new_text)
-          end
+        text = read_from_url
+        if has_valid_rates?(text)
+          store_in_cache(text)
         end
       rescue Errno::ENOENT
         raise InvalidCache
@@ -65,17 +53,48 @@ class Money
 
       protected
 
-      def find_rates_source
-        if !!cache && File.exist?(cache)
-          @rates_source = cache
+      # Store the provided text data by calling the proc method provided
+      # for the cache, or write to the cache file.
+      def store_in_cache(text)
+        if cache.is_a?(Proc)
+          cache.call(text)
+        elsif cache.is_a?(String)
+          open(cache, 'w') do |f|
+            f.write(text)
+          end
+        else
+          nil
+        end
+      end
+
+      def read_from_cache
+        if cache.is_a?(Proc)
+          cache.call(nil)
+        elsif cache.is_a?(String) && File.exist?(cache)
+          open(cache).read
         else
-          OER_URL
+          nil
         end
       end
 
+      def source_url
+        raise NoAppId if app_id.nil? || app_id.empty?
+        "#{OER_URL}?app_id=#{app_id}"
+      end
+
+      def read_from_url
+        open(source_url).read
+      end
+
+      def has_valid_rates?(text)
+        parsed = MultiJson.decode(text)
+        parsed && parsed.has_key?('rates')
+      rescue MultiJson::DecodeError
+        false
+      end
+
       def exchange_rates
-        @rates_source = find_rates_source
-        @doc = Yajl::Parser.parse(open(rates_source).read)
+        @doc = MultiJson.decode(read_from_cache || read_from_url)
         @oer_rates = @doc['rates']
         @doc['rates']
       end

data/test/open_exchange_rates_bank_test.rb

@@ -4,11 +4,16 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
 describe Money::Bank::OpenExchangeRatesBank do
 
+  before do
+    @cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'latest.json'))
+  end
+
   describe 'exchange' do
     include RR::Adapters::TestUnit
 
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
+      @bank.app_id = TEST_APP_ID
       @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
       @bank.cache = @temp_cache_path
       stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
@@ -16,20 +21,20 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
 
     it "should be able to exchange a money to its own currency even without rates" do
-      money = Money.new(0, "USD");
+      money = Money.new(0, "USD")
       @bank.exchange_with(money, "USD").must_equal money
     end
 
     it "should raise if it can't find an exchange rate" do
-      money = Money.new(0, "USD");
+      money = Money.new(0, "USD")
       assert_raises(Money::Bank::UnknownRateFormat){ @bank.exchange_with(money, "AUD") }
     end
   end
 
   describe 'update_rates' do
     before do
-      @cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'latest.json'))
       @bank = Money::Bank::OpenExchangeRatesBank.new
+      @bank.app_id = TEST_APP_ID
       @bank.cache = @cache_path
       @bank.update_rates
     end
@@ -45,7 +50,8 @@ describe Money::Bank::OpenExchangeRatesBank do
       @bank.oer_rates.keys.each do |currency|
         next unless Money::Currency.find(currency)
         subunit = Money::Currency.wrap(currency).subunit_to_unit
-        @bank.exchange(100, "USD", currency).cents.must_equal((@bank.oer_rates[currency].to_f * subunit).round)
+        @bank.exchange(100, "USD", currency).cents.
+          must_equal((@bank.oer_rates[currency].to_f * subunit).round)
       end
     end
 
@@ -53,8 +59,11 @@ describe Money::Bank::OpenExchangeRatesBank do
       @bank.oer_rates.keys.each do |currency|
         next unless Money::Currency.find(currency)
         subunit = Money::Currency.wrap(currency).subunit_to_unit
-        @bank.exchange_with(Money.new(100, "USD"), currency).cents.must_equal((@bank.oer_rates[currency].to_f * subunit).round)
-        @bank.exchange_with(1.to_money("USD"), currency).cents.must_equal((@bank.oer_rates[currency].to_f * subunit).round)
+        @bank.exchange_with(Money.new(100, "USD"), currency).cents.
+          must_equal((@bank.oer_rates[currency].to_f * subunit).round)
+
+        @bank.exchange_with(1.to_money("USD"), currency).cents.
+          must_equal((@bank.oer_rates[currency].to_f * subunit).round)
       end
       @bank.exchange_with(5000.to_money('JPY'), 'USD').cents.must_equal 6441
     end
@@ -94,18 +103,38 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
   end
 
+  describe 'App ID' do
+    include RR::Adapters::TestUnit
+
+    before do
+      @bank = Money::Bank::OpenExchangeRatesBank.new
+      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
+      @bank.cache = @temp_cache_path
+      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+    end
+
+    it 'should raise an error if no App ID is set' do
+      proc {@bank.save_rates}.must_raise Money::Bank::NoAppId
+    end
+
+    #TODO: As App IDs are compulsory soon, need to add more tests handle
+    # app_id-specific errors from
+    # https://openexchangerates.org/documentation#errors
+  end
+
   describe 'no cache' do
     include RR::Adapters::TestUnit
 
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.cache = nil
+      @bank.app_id = TEST_APP_ID
     end
 
     it 'should get from url' do
       stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
       @bank.update_rates
-      @bank.rates_source.must_equal Money::Bank::OpenExchangeRatesBank::OER_URL
+      @bank.oer_rates.wont_be_empty
     end
 
     it 'should raise an error if invalid path is given to save_rates' do
@@ -118,12 +147,13 @@ describe Money::Bank::OpenExchangeRatesBank do
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
       @bank.cache = "space_dir#{rand(999999999)}/out_space_file.json"
+      @bank.app_id = TEST_APP_ID
     end
 
     it 'should get from url' do
       stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
       @bank.update_rates
-      @bank.rates_source.must_equal Money::Bank::OpenExchangeRatesBank::OER_URL
+      @bank.oer_rates.wont_be_empty
     end
 
     it 'should raise an error if invalid path is given to save_rates' do
@@ -131,11 +161,45 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
   end
 
+  describe 'using proc for cache' do
+    include RR::Adapters::TestUnit
+
+    before :each do
+      $global_rates = nil
+      @bank = Money::Bank::OpenExchangeRatesBank.new
+      @bank.cache = Proc.new {|v|
+        if v
+          $global_rates = v
+        else
+          $global_rates
+        end
+      }
+      @bank.app_id = TEST_APP_ID
+    end
+
+    it 'should get from url normally' do
+      stub(@bank).source_url() { @cache_path }
+      @bank.update_rates
+      @bank.oer_rates.wont_be_empty
+    end
+
+    it 'should save from url and get from cache' do
+      stub(@bank).source_url { @cache_path }
+      @bank.save_rates
+      $global_rates.wont_be_empty
+      dont_allow(@bank).source_url
+      @bank.update_rates
+      @bank.oer_rates.wont_be_empty
+    end
+
+  end
+
   describe 'save rates' do
     include RR::Adapters::TestUnit
 
     before do
       @bank = Money::Bank::OpenExchangeRatesBank.new
+      @bank.app_id = "temp-e091fc14b3884a516d6cc2c299a"
       @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
       @bank.cache = @temp_cache_path
       stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }

data/test/test_helper.rb

@@ -2,3 +2,10 @@
 require 'minitest/autorun'
 require 'rr'
 require 'money/bank/open_exchange_rates_bank'
+
+TEST_APP_ID_PATH = File.join(File.dirname(__FILE__), '..', 'TEST_APP_ID')
+TEST_APP_ID = ENV['TEST_APP_ID'] || File.read(TEST_APP_ID_PATH)
+
+if TEST_APP_ID.nil? || TEST_APP_ID.empty?
+  raise "Please add a valid app id to file #{TEST_APP_ID_PATH} or to TEST_APP_ID environment"
+end

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
 - Laurent Arnoud
+- Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &20001460 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: &17136700 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *20001460
+  version_requirements: *17136700
 - !ruby/object:Gem::Dependency
   name: money
-  requirement: &20000360 !ruby/object:Gem::Requirement
+  requirement: &17136000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: 3.7.1
   type: :runtime
   prerelease: false
-  version_requirements: *20000360
+  version_requirements: *17136000
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &19999680 !ruby/object:Gem::Requirement
+  requirement: &17135280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +44,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *19999680
+  version_requirements: *17135280
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &19999220 !ruby/object:Gem::Requirement
+  requirement: &17134700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +55,7 @@ dependencies:
         version: 1.0.4
   type: :development
   prerelease: false
-  version_requirements: *19999220
+  version_requirements: *17134700
 description: A gem that calculates the exchange rate using published rates from open-exchange-rates.
   Compatible with the money gem.
 email: laurent@spkdev.net