exchange 0.5.1 → 0.6.0

data/Gemfile

@@ -1,17 +1,26 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-gem "nokogiri",   ">= 1.5.0"
-gem "json",       ">= 1.6.5"
-gem "memcached",  ">= 1.3.0"
-gem "redis",      ">= 2.2.0"
+#gem "nokogiri",   ">= 1.5.0"
+#gem "json",       ">= 1.6.5"
+#gem "memcached",  ">= 1.3.0"
+#gem "redis",      ">= 2.2.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
+
+gemspec
+
 group :development do
-  gem "shoulda", ">= 0"
-  gem "yard", "~> 0.7.4"
-  gem "bundler", "> 1.0.0"
-  gem "jeweler", "~> 1.8.3"
+  gem "yard",       "~> 0.7.4"
+  gem "bundler",    ">= 1.0.0"
+  gem "jeweler",    "~> 1.8.3"
+end
+
+group :test do
+  gem "nokogiri",   ">= 1.5.0", :require => false
+  gem "dalli",      ">= 2.0.0", :require => false
+  gem "redis",      ">= 2.2.0", :require => false
+  gem "shoulda",    ">= 0"
   gem "rspec"
 end

data/Gemfile.lock

@@ -1,6 +1,13 @@
+PATH
+  remote: .
+  specs:
+    exchange (0.6.0)
+      json (>= 1.0.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
+    dalli (2.2.1)
     diff-lcs (1.1.3)
     git (1.2.5)
     jeweler (1.8.3)
@@ -9,12 +16,11 @@ GEM
       rake
       rdoc
     json (1.6.6)
-    memcached (1.4.1)
-    nokogiri (1.5.0)
+    nokogiri (1.5.5)
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    redis (2.2.2)
+    redis (3.0.1)
     rspec (2.9.0)
       rspec-core (~> 2.9.0)
       rspec-expectations (~> 2.9.0)
@@ -34,10 +40,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (> 1.0.0)
+  bundler (>= 1.0.0)
+  dalli (>= 2.0.0)
+  exchange!
   jeweler (~> 1.8.3)
-  json (>= 1.6.5)
-  memcached (>= 1.3.0)
   nokogiri (>= 1.5.0)
   redis (>= 2.2.0)
   rspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 beatrichartz
+Copyright (c) 2012 Beat Richartz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,18 +1,21 @@
 = exchange {<img src="https://secure.travis-ci.org/beatrichartz/exchange.png" />}[http://travis-ci.org/beatrichartz/exchange]
 
-The Exchange Gem gives you easy access to currency functions directly on your Numbers. It has been tested against ruby 1.8.7, ree, ruby 1.9.2 and 1.9.3. You can use it with just plain ruby projects, in Rails 2 and 3, Sinatra, Padrino or whatever Framework you like.
+The Exchange Gem gives you easy access to currency functions directly on your Numbers. It has been tested against ruby 1.8.7, ree, ruby 1.9.2 and 1.9.3. You can use it with just plain ruby projects, in Rails 2 and 3, Sinatra or whatever Framework you like.
 
-=== Important Note
+=== Changelog
 
-Since The Currency Bot API, now renamed to Open Exchange Rates API at openexchangerates.org (http://openexchangerates.org), requires an APP ID now, you should configure it using the Exchange::Configuration
+== 0.6
+- Memcached, Redis, JSON and Nokogiri have been removed as explicit dependencies of the gem. The gem will now try to load the gems
+you want to use with it during runtime, and it will throw an exception if a gem required according to your configuration is not present.
+- The cache class is now a singleton and no class singleton anymore. This makes it easier to write a seamlessly integrating custom cache class for it.
+== 0.5
+- Changed the currency bot api to openexchangerates.org and changed the default api to xaviermedia. Since the openexchangerates.org api still supports a free plan with reasonable conditions, it will still be supported by the exchange gem, although it may be moved to a separate gem in the future
+== 0.4
+- Some potential 0 values on conversions when caching with memcached have been fixed.
+== 0.3
+- The ECB API has been added to the standard apis
 
-  Exchange::Configuration.define do |c|
-    c.api_app_id = 'YOUR_APP_ID'
-  end
-
-Also, since it is not my intention to support paid APIs with this gem, the default API has been moved to use the Xavier Media API at xaviermedia.org. However, since Open Exchange Rates (Currency Bot) still supports a free plan, I updated the gem to be able to use it.
-
-As a sidenote: Please be reasonable when using the APIs provided, and be sure to enable caching and mock out any http calls in your specs.
+==== Features
 
 === Easy Conversion
 
@@ -24,7 +27,7 @@ which gets you an exchange at the rates of yesterday.
 
 === Only one request per day to keep you up to date
 
-Imagine the exchange rates getting cached, and you hitting the internet only daily to get new rates (hourly if you're eager to have the absolutely newest ones)
+You're hitting the internet only daily to get new rates with this gem (hourly updates are available if you're eager to have the absolutely newest ones)
 
 === ISO 4217 Currency formatting
 On of the issues with currencies is: You never know the format they should be in. With Exchange, you can just use the currencies
@@ -40,9 +43,9 @@ a string with the currency code in front, or just the amount in the right format
 
 Three open APIs are already included: 
 
-- Currency Bot (http://currencybot.github.com/)
 - Xaviermedia (http://www.xavierforum.com/viewtopic.php?f=5&t=10979&sid=671a685edbfa5dbec219fbc6793d5057)
 - European Central Bank (http://www.ecb.int/stats/exchange/eurofxref/html/index.en.html)
+- Currency Bot (http://currencybot.github.com/)
 
 but if you have another API you like to use, it becomes as easy as writing one Class and two methods to use it with the Exchange gem. Just visit the documentation here: http://rubydoc.info/github/beatrichartz/exchange/Exchange/ExternalAPI to see an example of a custom API Extension
 

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.6.0

data/exchange.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "exchange"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Beat Richartz"]
-  s.date = "2012-10-02"
+  s.date = "2012-10-04"
   s.description = "The Exchange Gem gives you easy access to currency functions directly on your Numbers. Imagine a conversion as easy as \n    1.eur.to_usd\n  or even better \n    1.eur.to_usd(:at => Time.now - 84600)\n  which gets you an exchange at the rates of yesterday."
   s.email = "exchange_gem@gmail.com"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "iso4217.yml",
     "lib/core_extensions/conversability.rb",
     "lib/exchange.rb",
+    "lib/exchange/base.rb",
     "lib/exchange/cache.rb",
     "lib/exchange/cache/base.rb",
     "lib/exchange/cache/file.rb",
@@ -45,7 +46,10 @@ Gem::Specification.new do |s|
     "lib/exchange/external_api/call.rb",
     "lib/exchange/external_api/currency_bot.rb",
     "lib/exchange/external_api/ecb.rb",
+    "lib/exchange/external_api/json.rb",
     "lib/exchange/external_api/xavier_media.rb",
+    "lib/exchange/external_api/xml.rb",
+    "lib/exchange/gem_loader.rb",
     "lib/exchange/helper.rb",
     "lib/exchange/iso_4217.rb",
     "spec/core_extensions/conversability_spec.rb",
@@ -62,6 +66,7 @@ Gem::Specification.new do |s|
     "spec/exchange/external_api/currency_bot_spec.rb",
     "spec/exchange/external_api/ecb_spec.rb",
     "spec/exchange/external_api/xavier_media_spec.rb",
+    "spec/exchange/gem_loader_spec.rb",
     "spec/exchange/helper_spec.rb",
     "spec/exchange/iso_4217_spec.rb",
     "spec/spec_helper.rb",
@@ -82,36 +87,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, [">= 1.5.0"])
-      s.add_runtime_dependency(%q<json>, [">= 1.6.5"])
-      s.add_runtime_dependency(%q<memcached>, [">= 1.3.0"])
-      s.add_runtime_dependency(%q<redis>, [">= 2.2.0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<exchange>, [">= 0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7.4"])
-      s.add_development_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<nokogiri>, [">= 1.5.0"])
-      s.add_dependency(%q<json>, [">= 1.6.5"])
-      s.add_dependency(%q<memcached>, [">= 1.3.0"])
-      s.add_dependency(%q<redis>, [">= 2.2.0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<exchange>, [">= 0"])
       s.add_dependency(%q<yard>, ["~> 0.7.4"])
-      s.add_dependency(%q<bundler>, ["> 1.0.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<nokogiri>, [">= 1.5.0"])
-    s.add_dependency(%q<json>, [">= 1.6.5"])
-    s.add_dependency(%q<memcached>, [">= 1.3.0"])
-    s.add_dependency(%q<redis>, [">= 2.2.0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<exchange>, [">= 0"])
     s.add_dependency(%q<yard>, ["~> 0.7.4"])
-    s.add_dependency(%q<bundler>, ["> 1.0.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/lib/core_extensions/conversability.rb

@@ -4,11 +4,12 @@ module Exchange
   # @author Beat Richartz
   # @version 0.2
   # @since 0.1
-  
+  #
   module Conversability
+    
     # Dynamic method generation is used here to allow instantiation and immediate conversion of Currency objects from 
-    # a common Fixnum or Float or BigDecimal. Since ruby 1.9 handles certain type conversion of Fixnum, Float and others
-    # via method missing, this is not handled via method missing because it would seriously break down performance.
+    # a common Fixnum or Float or BigDecimal. Since some builds of ruby 1.9 handle certain type conversion of Fixnum, Float 
+    # and others via method missing, this is not handled via method missing because it would seriously break down performance.
     # 
     # @example Instantiate from any type of number
     #   40.usd => #<Exchange::Currency @value=40 @currency=:usd>
@@ -22,7 +23,7 @@ module Exchange
     #   1.usd.to_eur(:at => Time.now - 86400) => #<Exchange::Currency @value=0.80 @currency=:eur>
     #   1.nok.to_chf(:at => Time.now - 3600) => #<Exchange::Currency @value=6.57 @currency=:chf>
     #   -3.5.dkk.to_huf(:at => Time.now - 172800) => #<Exchange::Currency @value=-337.40 @currency=:huf>
-    
+    #
     ISO4217.definitions.keys.each do |c|
       define_method c.downcase.to_sym do |*args|
         Currency.new(self, c, *args)

data/lib/exchange.rb

@@ -1,19 +1,14 @@
-EXCHANGE_GEM_ROOT_PATH = File.dirname(__FILE__).sub(/\/lib$/, '') if __FILE__.is_a?(String)
-
+require 'rubygems'
 require 'bigdecimal'
 require 'open-uri'
-require 'bundler'
+require 'ostruct'
 require 'json'
-require 'nokogiri'
-require 'redis'
-require 'memcached'
+require 'exchange/base'
+require 'exchange/gem_loader'
 require 'exchange/helper'
-require 'exchange/configuration'
 require 'exchange/iso_4217'
 require 'exchange/currency'
 require 'exchange/external_api'
 require 'exchange/cache'
-require 'core_extensions/conversability'
-
-# The error that gets thrown if no conversion rate is available
-NoRateError = Class.new(StandardError)
+require 'exchange/configuration'
+require 'core_extensions/conversability'

data/lib/exchange/base.rb

@@ -0,0 +1,19 @@
+module Exchange
+  
+  # The current version of the exchange gem
+  #
+  VERSION = '0.6.0'
+  
+  # The root installation path of the gem
+  # @version 0.5
+  # @since 0.1
+  #
+  ROOT_PATH = File.dirname(__FILE__).to_s.sub(/\/lib\/exchange\/?$/, '')
+  
+  # The error that gets thrown if no conversion rate is available
+  # @version 0.1
+  # @since 0.1
+  #
+  NoRateError       = Class.new StandardError
+  
+end

data/lib/exchange/cache/base.rb

@@ -1,55 +1,80 @@
+require 'singleton'
+require 'forwardable'
+
 module Exchange
   # The cache module. All Classes handling caching for this gem have to be placed here. Allows easy extension with own caching solutions
   # as shown in the example below.
   # @example Write your own caching module
   #   module Cache
   #     class MyCustomCache < Base
-  #       class << self
-  #         # a cache class has to have the class method "cached"
-  #         def cached api, opts={}, &block
-  #           # generate the key with key(api, opts[:at]) and you will get a unique key to store in your cache
-  #           # Your code goes here
-  #         end
+  #       # a cache class has to have the class method "cached"
+  #       def cached api, opts={}, &block
+  #         # generate the key with key(api, opts[:at]) and you will get a unique key to store in your cache
+  #         # Your code goes here
   #       end
   #     end
   #   end
   #   # Now, you can configure your Caching solution in the configuration. The Symbol will get camelcased and constantized
-  #   Exchange::Configuration.cache = :my_custom_cache
+  #   configuration.cache.subclass = :my_custom_cache
   #   # Have fun, and don't forget to write tests.
   
   module Cache
     
     # The base Class for all Caching operations. Essentially generates a helper function for all cache classes to generate a key
     # @author Beat Richartz
-    # @version 0.1
+    # @version 0.6
     # @since 0.1
-    
+    #
     class Base
-      class << self
-        
-        protected
-        
-          # A Cache Key generator for the API Classes and the time
-          # Generates a key which can handle expiration by itself
-          # @param [Exchange::ExternalAPI::Subclass] api_class The API to store the data for
-          # @param [optional, Time] time The time for which the data is valid
-          # @return [String] A string that can be used as cache key
-          # @example
-          #   Exchange::Cache::Base.key(Exchange::ExternalAPI::CurrencyBot, Time.gm(2012,1,1)) #=> "Exchange_ExternalAPI_CurrencyBot_2012_1"
-          
-          def key(api, opts={})
-            time          = Exchange::Helper.assure_time(opts[:at], :default => :now)
-            [ 'exchange',
-              api.to_s, 
-              time.year.to_s, 
-              time.yday.to_s, 
-              Exchange::Configuration.update == :hourly ? time.hour.to_s : nil,
-              *(opts[:key_for] || [])
-            ].compact.join('_')
-          end
-        
+      include Singleton
+      extend SingleForwardable
+      
+      # returns The result of the block called
+      # This method has to be the same in all the cache classes in order for the configuration binding to work
+      # @param [Exchange::ExternalAPI::Subclass] api The API class the data has to be stored for
+      # @param [Hash] opts the options to cache with
+      # @option opts [Time] :at is ignored for filecache, other than that is the time of the cached rate
+      # @option opts [Symbol] :cache_period The period to cache for
+      # @yield [] This method takes a mandatory block with an arity of 0 and calls it if no cached result is available
+      # @raise [CachingWithoutBlockError] an Argument Error when no mandatory block has been given
+      #
+      def cached api, opts={}, &block
+        raise CachingWithoutBlockError.new('Caching needs a block') unless block_given?
+
+        block.call
       end
+      
+      # Forwards the cached method to the instance using singleforwardable
+      #
+      def_delegator :instance, :cached
+                    
+      protected
+      
+      # A Cache Key generator for the API Classes and the time
+      # Generates a key which can handle expiration by itself
+      # @param [Exchange::ExternalAPI::Subclass] api_class The API to store the data for
+      # @param [optional, Time] time The time for which the data is valid
+      # @return [String] A string that can be used as cache key
+      # @example
+      #   Exchange::Cache::Base.key(Exchange::ExternalAPI::CurrencyBot, Time.gm(2012,1,1)) #=> "Exchange_ExternalAPI_CurrencyBot_2012_1"
+      #
+      def key api, opts={}
+        time          = Exchange::Helper.assure_time(opts[:at], :default => :now)
+        [ 'exchange',
+          api.to_s, 
+          time.year.to_s, 
+          time.yday.to_s, 
+          Exchange.configuration.cache.expire == :hourly ? time.hour.to_s : nil,
+          *(opts[:key_for] || [])
+        ].compact.join('_')
+      end
+        
     end
+    
+    # The error getting thrown if caching is attempted without a given block
+    # @since 0.1
+    # @version 0.1
+    #
     CachingWithoutBlockError = Class.new(ArgumentError)
   end
 end

data/lib/exchange/cache/file.rb

@@ -5,61 +5,57 @@ module Exchange
     # A class that allows to store api call results in files. THIS NOT A RECOMMENDED CACHING OPTION!
     # It just may be necessary to cache large files somewhere, this class allows you to do that
     # 
-    # @version 0.3
+    # @version 0.6
     # @since 0.3
     
     class File < Base
-      class << self
         
-        # returns either cached data from a stored file or stores a file.
-        # This method has to be the same in all the cache classes in order for the configuration binding to work
-        # @param [Exchange::ExternalAPI::Subclass] api The API class the data has to be stored for
-        # @param [Hash] opts the options to cache with
-        # @option opts [Time] :at IS IGNORED FOR FILECACHE
-        # @option opts [Symbol] :cache_period The period to cache the file for
-        # @yield [] This method takes a mandatory block with an arity of 0 and calls it if no cached result is available
-        # @raise [CachingWithoutBlockError] an Argument Error when no mandatory block has been given
+      # returns either cached data from a stored file or stores a file.
+      # This method has to be the same in all the cache classes in order for the configuration binding to work
+      # @param [Exchange::ExternalAPI::Subclass] api The API class the data has to be stored for
+      # @param [Hash] opts the options to cache with
+      # @option opts [Time] :at IS IGNORED FOR FILECACHE
+      # @option opts [Symbol] :cache_period The period to cache the file for
+      # @yield [] This method takes a mandatory block with an arity of 0 and calls it if no cached result is available
+      # @raise [CachingWithoutBlockError] an Argument Error when no mandatory block has been given
+      #
+      def cached api, opts={}, &block
+        today = Time.now
+        dir   = Exchange.configuration.cache.path
+        path  = ::File.join(dir, key(api, opts[:cache_period]))
         
-        def cached api, opts={}, &block
-          raise CachingWithoutBlockError.new('Caching needs a block') unless block_given?
-          
-          today = Time.now
-          dir   = Exchange::Configuration.filestore_path
-          path  = ::File.join(dir, key(api, opts[:cache_period]))
-          
-          if ::File.exists?(path)
-            result = ::File.read(path)
-          else
-            result = block.call
-            if result && !result.to_s.empty?
-              FileUtils.mkdir_p(dir) unless Dir.respond_to?(:exists?) && Dir.exists?(dir)
-              keep_files = [key(api, :daily), key(api, :monthly)]
-              Dir.entries(dir).each do |e|
-                ::File.delete(::File.join(dir, e)) unless keep_files.include?(e) || e.match(/\A\./)
-              end
-              ::File.open(path, 'w') {|f| f.write(result) }
+        if ::File.exists?(path)
+          result = ::File.read(path)
+        else
+          result = super
+          if result && !result.to_s.empty?
+            FileUtils.mkdir_p(dir) unless Dir.respond_to?(:exists?) && Dir.exists?(dir)
+            keep_files = [key(api, :daily), key(api, :monthly)]
+            Dir.entries(dir).each do |e|
+              ::File.delete(::File.join(dir, e)) unless keep_files.include?(e) || e.match(/\A\./)
             end
+            ::File.open(path, 'w') {|f| f.write(result) }
           end
-          
-          result
         end
         
-        private
-        
-          # A Cache Key generator for the file Cache Class and the time
-          # Generates a key which can handle expiration by itself
-          # @param [Exchange::ExternalAPI::Subclass] api_class The API to store the data for
-          # @param [optional, Symbol] cache_period The time for which the data is valid
-          # @return [String] A string that can be used as cache key
-          # @example
-          #   Exchange::Cache::Base.key(Exchange::ExternalAPI::CurrencyBot, :monthly) #=> "Exchange_ExternalAPI_CurrencyBot_monthly_2012_1"
-          
-          def key(api_class, cache_period=:daily)
-            time      = Time.now
-            [api_class.to_s.gsub(/::/, '_'), cache_period, time.year, time.send(cache_period == :monthly ? :month : :yday)].join('_')
-          end
-        
+        result
       end
+      
+      private
+      
+      # A Cache Key generator for the file Cache Class and the time
+      # Generates a key which can handle expiration by itself
+      # @param [Exchange::ExternalAPI::Subclass] api_class The API to store the data for
+      # @param [optional, Symbol] cache_period The time for which the data is valid
+      # @return [String] A string that can be used as cache key
+      # @example
+      #   Exchange::Cache::Base.key(Exchange::ExternalAPI::CurrencyBot, :monthly) #=> "Exchange_ExternalAPI_CurrencyBot_monthly_2012_1"
+      #
+      def key(api_class, cache_period=:daily)
+        time      = Time.now
+        [api_class.to_s.gsub(/::/, '_'), cache_period, time.year, time.send(cache_period == :monthly ? :month : :yday)].join('_')
+      end
+    
     end
   end
 end