exchange 0.12.0 → 1.0.0

data/lib/exchange.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'rubygems'
 require 'bigdecimal'
 require 'open-uri'
@@ -11,4 +12,4 @@ require 'exchange/external_api'
 require 'exchange/cache'
 require 'exchange/configuration'
 require 'exchange/core_extensions'
-require 'exchange/typecasting'
+require 'exchange/typecasting'

data/lib/exchange/base.rb

@@ -1,8 +1,9 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   # The current version of the exchange gem
   #
-  VERSION = '0.12.0'
+  VERSION = '1.0.0'
   
   # The root installation path of the gem
   # @version 0.5
@@ -22,4 +23,4 @@ module Exchange
   #
   NoCurrencyError   = Class.new(ArgumentError)
   
-end
+end

data/lib/exchange/cache.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'exchange/cache/configuration'
 require 'exchange/cache/base'
 require 'exchange/cache/memcached'

data/lib/exchange/cache/base.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'singleton'
 require 'forwardable'
 
@@ -99,4 +100,4 @@ module Exchange
     #
     CachingWithoutBlockError = Class.new(ArgumentError)
   end
-end
+end

data/lib/exchange/cache/configuration.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     # @author Beat Richartz
@@ -52,4 +53,4 @@ module Exchange
             
     end
   end 
-end
+end

data/lib/exchange/cache/file.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     
@@ -73,4 +74,4 @@ module Exchange
     
     end
   end
-end
+end

data/lib/exchange/cache/memcached.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     # @author Beat Richartz
@@ -57,4 +58,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/cache/memory.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     # @author Beat Richartz
@@ -86,4 +87,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/cache/no_cache.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     
@@ -10,4 +11,4 @@ module Exchange
     NoCache = Class.new Base
     
   end
-end
+end

data/lib/exchange/cache/rails.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     # @author Beat Richartz
@@ -42,4 +43,4 @@ module Exchange
         
     end
   end
-end
+end

data/lib/exchange/cache/redis.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cache
     # @author Beat Richartz
@@ -56,4 +57,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/configurable.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'singleton'
 require 'forwardable'
 
@@ -10,7 +11,7 @@ module Exchange
     attr_accessor :subclass
     
     def_delegators :instance, :subclass, :subclass=, :set
-     
+    
     def subclass_with_constantize
       self.subclass = parent_module.const_get camelize(self.subclass_without_constantize) unless !self.subclass_without_constantize || self.subclass_without_constantize.is_a?(Class)
       subclass_without_constantize
@@ -55,4 +56,4 @@ module Exchange
     
   end
   
-end
+end

data/lib/exchange/configuration.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   class << self
@@ -67,7 +68,7 @@ module Exchange
     end
     
     # The configuration defaults
-    # @version 0.6
+    # @version 1.0
     # @since 0.6
     #
     DEFAULTS = { 
@@ -75,7 +76,8 @@ module Exchange
                     :subclass => ExternalAPI::XavierMedia, 
                     :retries => 5,
                     :protocol => :http,
-                    :app_id => nil
+                    :app_id => nil,
+                    :fallback => ExternalAPI::Ecb
                   },
                   :cache => {
                     :subclass => Cache::Memory,
@@ -143,8 +145,9 @@ module Exchange
     # @since 0.6
     # @version 0.6
     # @param [Hash] The hash to set the configuration to
-    # @option [Symbol] :subclass The API subclass to use as a underscored symbol (will be camelized and constantized)
+    # @option [Symbol] :subclass The API subclass to use as a underscored symbol (will be camelized and constantized). Options available are :open_exchange_rates, :xavier_media, :ecb and :random (Random Rates for development use). You can build your own api subclass by following instructions under external_api/base.rb
     # @option [Integer] :retries The amount of retries on connection failure
+    # @option [Array,Symbol,Class] :fallback An array of fallbacks to be tried in the event when the standard API lookup fails or the standard API does not support the given currency 
     # @example set the api to be ecb with a maximum of 8 retries on connection failure
     #   configuration.api = { :subclass => :ecb, :retries => 8 }
     #
@@ -154,7 +157,7 @@ module Exchange
     # @since 0.6
     # @version 0.6
     # @param [Hash] The hash to set the configuration to
-    # @option [Symbol] :subclass The Cache subclass to use as a underscored symbol (will be camelized and constantized)
+    # @option [Symbol] :subclass The Cache subclass to use as a underscored symbol (will be camelized and constantized). Options available are :memcached (via Dalli), :redis, :rails and :memory (default). You can build your own cache subclass by following instructions under cache/base.rb
     # @option [String] :host The cache connection host
     # @option [Integer] :port The cache connection port
     # @option [Symbol] :expire The expiration period for the cache, can be :daily or :hourly, defaults to daily
@@ -176,4 +179,4 @@ module Exchange
     install_getter :cache
       
   end
-end
+end

data/lib/exchange/core_extensions.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'exchange/core_extensions/numeric/conversability'
 require 'exchange/core_extensions/float/error_safe'
-require 'exchange/core_extensions/cachify'
+require 'exchange/core_extensions/cachify'

data/lib/exchange/core_extensions/cachify.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module Cachify
     
@@ -22,4 +23,4 @@ Symbol.send   :include, Exchange::Cachify
 String.send   :include, Exchange::Decachify
 Hash.send     :include, Exchange::Cachify
 Array.send    :include, Exchange::Cachify
-NilClass.send :include, Exchange::Cachify
+NilClass.send :include, Exchange::Cachify

data/lib/exchange/core_extensions/float/error_safe.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   # Make Floating Points forget about their incapabilities when dealing with money
@@ -41,4 +42,4 @@ module Exchange
   
 end
 
-Float.send(:include, Exchange::ErrorSafe)
+Float.send(:include, Exchange::ErrorSafe)

data/lib/exchange/core_extensions/numeric/conversability.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   # The conversability module which will get included in Fixnum and Float, giving them the in currency instantiate methods
@@ -35,4 +36,4 @@ module Exchange
 end
 
 # include the Conversability methods in all number operations. Stack traces will indicate the module if something goes wrong.
-Numeric.send :include, Exchange::Conversability
+Numeric.send :include, Exchange::Conversability

data/lib/exchange/external_api.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'exchange/external_api/configuration'
 require 'exchange/external_api/base'
 require 'exchange/external_api/xml'
@@ -5,4 +6,5 @@ require 'exchange/external_api/json'
 require 'exchange/external_api/call'
 require 'exchange/external_api/open_exchange_rates'
 require 'exchange/external_api/xavier_media'
-require 'exchange/external_api/ecb'
+require 'exchange/external_api/ecb'
+require 'exchange/external_api/random'

data/lib/exchange/external_api/base.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   # The external API module. Every class Handling an API has to be placed here and inherit from base. It has to call an api and define
@@ -194,4 +195,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/external_api/call.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     
@@ -75,4 +76,4 @@ module Exchange
     APIError = Class.new(StandardError)
     
   end
-end
+end

data/lib/exchange/external_api/configuration.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     # @author Beat Richartz
@@ -8,9 +9,23 @@ module Exchange
     #
     class Configuration < Exchange::Configurable
 
-      attr_accessor :retries, :app_id, :protocol
+      attr_accessor :retries, :app_id, :protocol, :fallback
       
-      def_delegators :instance, :retries, :retries=, :app_id, :app_id=, :protocol, :protocol=
+      def_delegators :instance, :retries, :retries=, :app_id, :app_id=, :protocol, :protocol=, :fallback, :fallback=
+      
+      def fallback_with_constantize
+        self.fallback = Array(fallback_without_constantize).map do |fb|
+          unless !fb || fb.is_a?(Class)
+            parent_module.const_get camelize(fb)
+          else
+            fb
+          end
+        end
+        
+        fallback_without_constantize
+      end
+      alias_method :fallback_without_constantize, :fallback
+      alias_method :fallback, :fallback_with_constantize
       
       def parent_module
         ExternalAPI
@@ -22,4 +37,4 @@ module Exchange
       
     end
   end 
-end
+end

data/lib/exchange/external_api/ecb.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     
@@ -127,4 +128,4 @@ module Exchange
         
     end
   end
-end
+end

data/lib/exchange/external_api/json.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     
@@ -19,4 +20,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/external_api/open_exchange_rates.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     # The Open Exchange Rates API class, handling communication with the Open Source Currency bot API
@@ -62,4 +63,4 @@ module Exchange
         
     end
   end
-end
+end

data/lib/exchange/external_api/random.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+module Exchange
+  module ExternalAPI
+    
+    # The Random API class, which is only intended for use in development mode. Returns random exchange rates.
+    # @author Beat Richartz
+    # @version 1.0
+    # @since 1.0
+    #
+    class Random < Base
+      
+      CURRENCIES           = Exchange::ISO.currencies
+      RANDOM_RATES         = lambda { Hash[*CURRENCIES.zip(CURRENCIES.size.times.map{|i| rand}).flatten] }
+      
+      # Updates the rates with new random ones
+      # The call gets cached for a maximum of 24 hours.
+      # @version 0.7
+      # @param [Hash] opts Options to define for the API Call
+      # @option opts [Time, String] :at a historical date to get the exchange rates for
+      # @example Update the currency bot API to use the file of March 2, 2010
+      #   Exchange::ExternalAPI::XavierMedia.new.update(:at => Time.gm(3,2,2010))
+      #
+      def update(opts={})
+        @base                 = :usd
+        @rates                = RANDOM_RATES.call
+        @timestamp            =  Time.now.to_i
+      end
+
+    end
+  end
+end

data/lib/exchange/external_api/xavier_media.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     
@@ -89,4 +90,4 @@ module Exchange
         
     end
   end
-end
+end

data/lib/exchange/external_api/xml.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   module ExternalAPI
     
@@ -19,4 +20,4 @@ module Exchange
       
     end
   end
-end
+end

data/lib/exchange/gem_loader.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Exchange
   
   # The gem loader takes care of loading gems without adding too many unnecessary dependencies to the gem
@@ -32,4 +33,4 @@ module Exchange
       raise GemNotFoundError.new("You specified #{@gem} to be used with Exchange, yet it is not loadable. Please install #{@gem} to be able to use it with Exchange")
     end
   end
-end
+end

data/lib/exchange/helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'singleton'
 require 'forwardable'
 
@@ -31,4 +32,4 @@ module Exchange
     
   end
   
-end
+end

data/lib/exchange/iso.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'singleton'
 require 'forwardable'
 require 'yaml'
@@ -22,9 +23,16 @@ module Exchange
       
         def install_operation op      
           self.class_eval <<-EOV
-            def #{op}(amount, currency, precision=nil)
+            def #{op}(amount, currency, precision=nil, opts={})
               minor = definitions[currency][:minor_unit]
-              (amount.is_a?(BigDecimal) ? amount : BigDecimal.new(amount.to_s, precision_for(amount, currency))).#{op}(precision || minor)
+              money = amount.is_a?(BigDecimal) ? amount : BigDecimal.new(amount.to_s, precision_for(amount, currency))
+              if opts[:psych] && minor > 0
+                money.#{op}(0) - BigDecimal.new((1.0/(10**minor)).to_s)
+              elsif opts[:psych]
+                (((money.#{op}(0) / BigDecimal.new("10.0")).#{op}(0)) - BigDecimal.new("0.1")) * BigDecimal.new("10")
+              else
+                money.#{op}(precision || minor)
+              end
             end
           EOV
         end
@@ -92,7 +100,7 @@ module Exchange
     # @param [BigDecimal, Fixed, Float] amount The amount of currency you want to stringify
     # @param [String, Symbol] currency The currency you want to stringify
     # @param [Hash] opts The options for formatting
-    # @option opts [Boolean] :amount_only Whether you want to have the currency in the string or not
+    # @option opts [Boolean] :format The format to put the string out in: :amount for only the amount, :symbol for a string with a currency symbol
     # @return [String] The formatted string
     # @example Convert a currency to a string
     #   Exchange::ISO.stringify(49.567, :usd) #=> "USD 49.57"
@@ -104,9 +112,22 @@ module Exchange
     #   Exchange::ISO.stringif(34.34, :omr, :amount_only => true) #=> "34.340"
     #
     def stringify(amount, currency, opts={})
-      format      = "%.#{definitions[currency][:minor_unit]}f"
-      pre         = [opts[:amount_only] && '', opts[:symbol] && (definitions[currency][:symbol] || currency.to_s.upcase), currency.to_s.upcase + ' '].detect{|a| a.is_a?(String)}
-      "#{pre}#{format % amount}"
+      definition    = definitions[currency]
+      separators    = definition[:separators] || {}
+      format        = "%.#{definition[:minor_unit]}f"
+      string        = format % amount
+      major, minor  = string.split('.')
+      
+      if separators[:major]
+        major.reverse!
+        major.gsub!(/(\d{3})(?=.)/) { $1 + separators[:major] }
+        major.reverse!
+      end
+      
+      string      = minor ? major + (separators[:minor] || '.') + minor : major
+      pre         = [opts[:format] == :amount && '', opts[:format] == :symbol && definition[:symbol], currency.to_s.upcase + ' '].detect{|a| a.is_a?(String)}
+      
+      "#{pre}#{string}"
     end
     
     # Use this to round a currency amount. This allows us to round exactly to the number of minors the currency has in the 
@@ -148,12 +169,7 @@ module Exchange
       new_hsh = Hash.new
       
       hsh.each_pair do |k,v| 
-        if v.is_a?(Hash)
-          v.keys.each do |key|
-            v[key.to_sym] = v.delete(key)
-          end
-        end
-        
+        v = symbolize_keys v if v.is_a?(Hash)        
         new_hsh[k.downcase.to_sym] = v
       end
       
@@ -172,4 +188,4 @@ module Exchange
     end
     
   end
-end
+end