exchange 0.8.0 → 0.9.0

data/lib/exchange/typecasting.rb

@@ -0,0 +1,94 @@
+module Exchange
+  
+  # Allows to access properties of an object as currencies
+  # The setter takes care of passing the right values to the original setter method,
+  # The getter takes care of instantiating a currency of the original getter method,
+  # This is framework agnostic. It works in ActiveRecord/Rails, Datamapper, Ohm, Your own, whatever you want
+  #
+  # @example The setter converts the currency automatically when the currency is not the one set (example in Active Record)
+  #   class MyClass < ActiveRecord::Base
+  #     extend Exchange::Typecasting
+  #     money :price, :currency => lambda { |s| s.manager.currency }
+  #     
+  #     has_one :manager
+  #
+  #     attr_accessible :price
+  #
+  #   end
+  #   
+  #   MyClass.find(1).update_attributes :price => 1.usd
+  #   MyClass.find(1).price #=> 0.77 EUR
+  # 
+  # @example The getter sets the currency automatically to the currency set in the definition (example in Ohm)
+  #   class MyClass < Ohm::Model
+  #     extend Exchange::Typecasting
+  #     reference :manager, Manager
+  #     attribute :price
+  #   
+  #     money :price, :currency => :manager_currency
+  #
+  #     def manager_currency
+  #       manager.currency
+  #     end
+  #     
+  #   end
+  #
+  #   my_instance = MyClass[0]
+  #   my_instance.price #=> instance of exchange currency in eur
+  #
+  #   manager = my_instance.manager
+  #   managermanager.update :currency => :usd
+  #   my_instance.price #=> instance of exchange currency in usd
+  #
+  module Typecasting
+
+    # installs a setter and a getter for the attribute you want to typecast as exchange money
+    
+    def money *attributes
+      
+      options = attributes.last.is_a?(Hash) ? attributes.pop : {}
+      
+      attributes.each do |attribute|
+        
+        define_method :"#{attribute}_with_exchange_typecasting" do
+          currency = evaluate_money_option(options[:currency]) if options[:currency]
+          raise NoCurrencyError.new("No currency is given for typecasting #{attributes.join(', ')}. Make sure a currency is present") unless currency
+          
+          time     = evaluate_money_option(options[:at]) if options[:at]
+          
+          Exchange::Money.new(send(:"#{attribute}_without_exchange_typecasting")) do |c|
+            c.currency = currency
+            c.time     = time if time
+          end
+        end
+        alias_method :"#{attribute}_without_exchange_typecasting", attribute.to_sym
+        alias_method attribute.to_sym, :"#{attribute}_with_exchange_typecasting"
+      
+        define_method :"#{attribute}_with_exchange_typecasting=" do |data|
+          att = send(attribute)
+          
+          if !data.respond_to?(:currency)
+            send(:"#{attribute}_without_exchange_typecasting=", data)
+          elsif att.currency == data.currency
+            send(:"#{attribute}_without_exchange_typecasting=", data.value)
+          elsif att.currency != data.currency
+            send(:"#{attribute}_without_exchange_typecasting=", data.send(:"to_#{att.currency}").value)
+          end
+        end
+        alias_method :"#{attribute}_without_exchange_typecasting=", :"#{attribute}="
+        alias_method :"#{attribute}=", :"#{attribute}_with_exchange_typecasting="
+        
+      end
+      
+      define_method :evaluate_money_option do |option|
+        option.is_a?(Proc) ? instance_eval(&option) : send(option)
+      end
+    end
+        
+    # Is raised when no currency is given for typecasting
+    #
+    NoCurrencyError = Class.new(ArgumentError)
+    
+  end
+
+end

data/spec/exchange/cache/base_spec.rb

@@ -10,7 +10,7 @@ describe "Exchange::Cache::Base" do
     context "with a daily cache" do
       it "should build a timestamped key with the class given, the yearday and the year" do
         subject.send(:key, :xavier_media).should == 'exchange_xavier_media_2012_61'
-        subject.send(:key, :currency_bot).should == 'exchange_currency_bot_2012_61'
+        subject.send(:key, :open_exchange_rates).should == 'exchange_open_exchange_rates_2012_61'
       end
     end
     context "with an hourly cache" do
@@ -22,7 +22,7 @@ describe "Exchange::Cache::Base" do
       end
       it "should build a timestamped key with the class given, the yearday, the year and the hour" do
         subject.send(:key, :xavier_media).should == 'exchange_xavier_media_2012_61_23'
-        subject.send(:key, :currency_bot).should == 'exchange_currency_bot_2012_61_23'
+        subject.send(:key, :open_exchange_rates).should == 'exchange_open_exchange_rates_2012_61_23'
       end
     end
   end

data/spec/exchange/cache/configuration_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe "Exchange::Cache::Configuration" do
+  
+  subject { Exchange::Cache::Configuration.instance }
+  
+  describe "attr_readers" do
+    [:subclass, :expire, :host, :port, :path].each do |reader|
+      it "should respond to #{reader}" do
+        subject.should be_respond_to(reader)
+      end
+      it "should respond to #{reader}=" do
+        subject.should be_respond_to(:"#{reader}=")
+      end
+    end
+  end
+  
+  describe "subclass constantize" do
+    it "should automatically constantize the subclass" do
+      subject.subclass = :no_cache
+      
+      subject.subclass.should == Exchange::Cache::NoCache
+    end
+  end
+  
+  describe "set" do
+    before(:each) do
+      @return = subject.set :subclass => :no_cache, :expire => :daily, :host => 'localhost', :port => 112211, :path => "PATH"
+    end
+    it "should set the options given" do
+      subject.subclass.should == Exchange::Cache::NoCache
+      subject.expire.should == :daily
+      subject.host.should == 'localhost'
+      subject.port.should == 112211
+      subject.path.should == 'PATH'
+    end
+    it "should return self" do
+      @return.should == subject
+    end
+  end
+  
+  describe "reset" do
+    before(:each) do
+      subject.set :subclass => :no_cache, :expire => :daily, :host => 'localhost', :port => 112211, :path => "PATH"
+    end
+    it "should restore the defaults" do
+      subject.reset
+      subject.subclass.should == Exchange::Cache::Memory
+      subject.expire.should == :daily
+      subject.host.should be_nil
+      subject.port.should be_nil
+      subject.path.should be_nil
+    end
+  end
+  
+end

data/spec/exchange/cache/file_spec.rb

@@ -11,11 +11,7 @@ describe "Exchange::Cache::File" do
     }
   end
   after(:each) do
-    Exchange.configuration = Exchange::Configuration.new { |c|
-      c.cache      = {
-        :subclass => :memcached
-      }
-    }
+    Exchange.configuration.reset
   end
   describe "cached" do
     it "should raise an error if no block was given" do
@@ -26,21 +22,27 @@ describe "Exchange::Cache::File" do
         before(:each) do
           subject.should_receive(:key).with('API_CLASS', nil).and_return('KEY')
           ::File.should_receive(:exists?).with('STORE/PATH/KEY').and_return(true)
-          ::File.should_receive(:read).with('STORE/PATH/KEY').and_return 'CONTENT'
+          ::File.should_receive(:read).with('STORE/PATH/KEY').and_return 'CONTENT'.cachify
         end
         it "should return the file contents" do
           subject.cached('API_CLASS') { 'something' }.should == 'CONTENT'
         end
+        it "should also return plain when asked to" do
+          subject.cached('API_CLASS', :plain => true) { 'something' }.should == 'CONTENT'.cachify
+        end
       end
-      context "with an monthly cache" do
+      context "with a monthly cache" do
         before(:each) do
           subject.should_receive(:key).with('API_CLASS', an_instance_of(Symbol)).and_return('KEY')
           ::File.should_receive(:exists?).with('STORE/PATH/KEY').and_return(true)
-          ::File.should_receive(:read).with('STORE/PATH/KEY').and_return 'CONTENT'
+          ::File.should_receive(:read).with('STORE/PATH/KEY').and_return 'CONTENT'.cachify
         end
         it "should return the file contents" do
           subject.cached('API_CLASS', :cache_period => :monthly) { 'something' }.should == 'CONTENT'
         end
+        it "should also return plain when asked to" do
+          subject.cached('API_CLASS', :cache_period => :monthly, :plain => true) { 'something' }.should == 'CONTENT'.cachify
+        end
       end
     end
     context "when no file is cached yet" do

data/spec/exchange/cache/memcached_spec.rb

@@ -11,12 +11,7 @@ describe "Exchange::CacheDalli::Client" do
     }
   end
   after(:each) do
-    Exchange.configuration = Exchange::Configuration.new { |c|
-      c.cache = {
-        :host => 'localhost',
-        :port => 11211
-      }
-    }
+    Exchange.configuration.reset
   end
   describe "client" do
     let(:client) { mock('memcached') }
@@ -43,10 +38,10 @@ describe "Exchange::CacheDalli::Client" do
       lambda { subject.cached('API_CLASS') }.should raise_error(Exchange::Cache::CachingWithoutBlockError)
     end
     context "when a cached result exists" do
-      context "when loading json" do
+      context "when loading" do
         before(:each) do
           subject.should_receive(:key).with('API_CLASS', {}).and_return('KEY')
-          client.should_receive(:get).with('KEY').and_return "{\"RESULT\":\"YAY\"}"
+          client.should_receive(:get).with('KEY').and_return({'RESULT' => 'YAY'}.cachify)
         end
         it "should return the JSON loaded result" do
           subject.cached('API_CLASS') { 'something' }.should == {'RESULT' => 'YAY'}
@@ -57,12 +52,8 @@ describe "Exchange::CacheDalli::Client" do
           subject.should_receive(:key).with('API_CLASS', {:plain => true}).and_return('KEY')
         end
         it "should return a String result in the right format" do
-          client.should_receive(:get).with('KEY').and_return "122.0"
-          subject.cached('API_CLASS', :plain => true) { 'something' }.should == "122.0"
-        end
-        it "should also return a String result in the right format when memcached adds quotes and spaces" do
-          client.should_receive(:get).with('KEY').and_return "\"122.0\" "
-          subject.cached('API_CLASS', :plain => true) { 'something' }.should == "122.0"
+          client.should_receive(:get).with('KEY').and_return "122.0".cachify
+          subject.cached('API_CLASS', :plain => true) { 'something' }.should == "122.0".cachify
         end
       end
     end
@@ -75,7 +66,7 @@ describe "Exchange::CacheDalli::Client" do
         end
         context "with daily cache" do
           it "should call the block and set and return the result" do
-            client.should_receive(:set).with('KEY', "{\"RESULT\":\"YAY\"}", 86400).once
+            client.should_receive(:set).with('KEY', {'RESULT' => 'YAY'}.cachify, 86400).once
             subject.cached('API_CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
           end
         end
@@ -87,7 +78,7 @@ describe "Exchange::CacheDalli::Client" do
             Exchange.configuration.cache.expire = :daily
           end
           it "should call the block and set and return the result" do
-            client.should_receive(:set).with('KEY', "{\"RESULT\":\"YAY\"}", 3600).once
+            client.should_receive(:set).with('KEY', {'RESULT' => 'YAY'}.cachify, 3600).once
             subject.cached('API_CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
           end
         end
@@ -99,7 +90,7 @@ describe "Exchange::CacheDalli::Client" do
         end
         context "with daily cache" do
           it "should call the block and set and return the result" do
-            client.should_receive(:set).with('KEY', "{\"RESULT\":\"YAY\"}", 86400).once
+            client.should_receive(:set).with('KEY', {'RESULT' => 'YAY'}.cachify, 86400).once
             subject.cached('API_CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
           end
         end
@@ -111,7 +102,7 @@ describe "Exchange::CacheDalli::Client" do
             Exchange.configuration.cache.expire = :daily
           end
           it "should call the block and set and return the result" do
-            client.should_receive(:set).with('KEY', "{\"RESULT\":\"YAY\"}", 3600).once
+            client.should_receive(:set).with('KEY', {'RESULT' => 'YAY'}.cachify, 3600).once
             subject.cached('API_CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
           end
         end

data/spec/exchange/cache/memory_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe "Exchange::Cache::Memory" do
+  subject { Exchange::Cache::Memory.instance }
+  before(:each) do
+    Exchange.configuration = Exchange::Configuration.new { |c|
+      c.cache = { :subclass => :memory }
+    }
+  end
+  after(:each) do
+    Exchange.configuration.reset
+  end
+  describe "instance_variable_name" do
+    context "with a class" do
+      before(:each) do
+        @time = Time.gm(2012,10,10,12)
+        Time.stub! :now => @time
+      end
+      it "should yield a valid instance variable name" do
+        subject.send(:instance_variable_name, Exchange::ExternalAPI::Ecb, {}).should == '@exchange_externalapi_ecb_2012_284_2012_284'
+      end
+    end
+  end
+  describe "clean_out_cache" do
+    before(:each) do
+      @time = Time.gm(2012,10,10,12)
+      Time.stub! :now => @time
+      subject.instance_variable_set '@exchange_externalapi_someapi_2011_284_2011_284_chfeur', 'Expired'
+      subject.instance_variable_set '@exchange_externalapi_someapi_2010_284_2012_284_chfeur', 'Valid1'
+      subject.instance_variable_set '@exchange_externalapi_ecb_2012_283_2011_283', 'Expired'
+      subject.instance_variable_set '@exchange_externalapi_ecb_2012_282_2012_284_chfusd', 'Valid2'
+      subject.instance_variable_set '@exchange_externalapi_currency_2012_284_11_2012_284_11', 'Expired'
+      subject.instance_variable_set '@exchange_externalapi_something_2012_284_12_2012_284_12', 'Valid3'
+      subject.instance_variable_set '@exchange_externalapi_something_2009_284_12_2012_284_12', 'Valid4'
+      subject.instance_variable_set '@exchange_externalapi_open_exchange_rates_2010_280_8_2012_284_8', 'Expired'
+      subject.instance_variable_set '@exchange_externalapi_xaviermedia_2012_84_12_2012_123_8', 'Expired'
+    end
+    it "should unset all expired instance variables" do
+      subject.send(:clean!)
+      subject.instance_variables.reject{|i| i.to_s == "@helper" }.map{|i| subject.instance_variable_get(i) }.compact.sort_by(&:to_s).should == %W(Valid1 Valid2 Valid3 Valid4).sort
+    end
+  end
+  describe "cached" do
+    it "should raise an error if no block was given" do
+      lambda { subject.cached('API_CLASS') }.should raise_error(Exchange::Cache::CachingWithoutBlockError)
+    end
+    context "when a cached result exists" do
+      context "when loading json" do
+        before(:each) do
+          subject.should_receive(:instance_variable_name).with('API::CLASS', {}).and_return('@KEY')
+          subject.should_receive(:instance_variable_get).with('@KEY').and_return('something')
+        end
+        it "should return the loaded result" do
+          subject.cached('API::CLASS') { 'something' }.should == 'something'
+        end
+      end
+      context "when loading plain" do
+        before(:each) do
+          subject.should_receive(:instance_variable_name).with('API::CLASS', {:plain => true}).and_return('@KEY')
+        end
+        it "should return a String result in the right format" do
+          subject.should_receive(:instance_variable_get).with('@KEY').and_return "0.122E3"
+          subject.cached('API::CLASS', :plain => true) { 'something' }.should == "0.122E3".cachify
+        end
+        it "should return a Hash result in the right format" do
+          subject.should_receive(:instance_variable_get).with('@KEY').and_return({'RESULT' => 'YAY'})
+          subject.cached('API::CLASS', :plain => true) { 'something' }.should == {'RESULT' => 'YAY'}.cachify
+        end
+      end
+    end
+    context "when no cached result exists" do
+      context "when returning nil" do
+        before(:each) do
+          subject.should_receive(:instance_variable_name).with('API::CLASS', {}).once.and_return('@KEY')
+          subject.should_receive(:instance_variable_get).with('@KEY').and_return(nil)
+        end
+        context "with daily cache" do
+          it "should call the block and set and return the result" do
+            subject.should_receive(:instance_variable_set).with('@KEY', {'RESULT' => 'YAY'}).once
+            subject.cached('API::CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
+          end
+        end
+        context "with hourly cache" do
+          before(:each) do
+            Exchange.configuration.cache.expire = :hourly
+          end
+          after(:each) do
+            Exchange.configuration.cache.expire = :daily
+          end
+          it "should call the block and set and return the result" do
+            subject.should_receive(:instance_variable_set).with('@KEY', {'RESULT' => 'YAY'}).once
+            subject.cached('API::CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
+          end
+        end
+      end
+      context "when returning an empty string" do
+        before(:each) do
+          subject.should_receive(:instance_variable_name).with('API::CLASS', {}).once.and_return('@KEY')
+          subject.should_receive(:instance_variable_get).with('@KEY').and_return('')
+        end
+        context "with daily cache" do
+          it "should call the block and set and return the result" do
+            subject.should_receive(:instance_variable_set).with('@KEY', {'RESULT' => 'YAY'}).once
+            subject.cached('API::CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
+          end
+        end
+        context "with hourly cache" do
+          before(:each) do
+            Exchange.configuration.cache.expire = :hourly
+          end
+          after(:each) do
+            Exchange.configuration.cache.expire = :daily
+          end
+          it "should call the block and set and return the result" do
+            subject.should_receive(:instance_variable_set).with('@KEY', {'RESULT' => 'YAY'}).once
+            subject.cached('API::CLASS') { {'RESULT' => 'YAY'} }.should == {'RESULT' => 'YAY'}
+          end
+        end
+      end
+    end
+  end
+end

data/spec/exchange/cache/no_cache_spec.rb

@@ -1,26 +1,16 @@
 require 'spec_helper'
 
-describe "Exchange::Cache::Rails" do
-  context "with rails defined" do
-    class ::Rails
-    end
-  end
+describe "Exchange::Cache::NoCache" do
   subject { Exchange::Cache::NoCache }
-  before(:each) do
+  before(:all) do
     Exchange.configuration = Exchange::Configuration.new { |c|
       c.cache = {
-        :class => :no_cache
+        :subclass => :no_cache
       }
     }
   end
-  after(:each) do
-    Exchange.configuration = Exchange::Configuration.new { |c|
-      c.cache = {
-        :class => :memcached,
-        :host => 'localhost',
-        :port => 11211
-      }
-    }
+  after(:all) do
+    Exchange.configuration.reset
   end
   describe "cached" do
     it "should directly call the block" do

data/spec/exchange/cache/rails_spec.rb

@@ -9,16 +9,12 @@ describe "Exchange::Cache::Rails" do
   before(:each) do
     Exchange.configuration = Exchange::Configuration.new { |c|
       c.cache = {
-        :class => :rails
+        :subclass => :rails
       }
     }
   end
   after(:each) do
-    Exchange.configuration = Exchange::Configuration.new { |c|
-      c.cache = {
-        :class => :memcached
-      }
-    }
+    Exchange.configuration.reset
   end
   describe "client" do
     let(:client) { mock('rails_cache') }