redis-bank 0.0.1

data/README.md

@@ -0,0 +1,19 @@
+Redis-Bank
+==========
+
+A Redis-backed bank for the Money gem.
+
+Usage
+-----
+
+```ruby
+redis_client = Redis.new
+# Or, if you'd rather just test it out without firing up redis,
+# you can just use a hash, e.g.
+# redis_client = {}
+Money.bank = Money::Bank::RedisBank.new redis_client
+Money.bank.add_rate("USD", "CAD", 1.24515)
+Money.bank.add_rate("CAD", "USD", 0.803115)
+Money.us_dollar(100).exchange_to("CAD") => Money.ca_dollar(124)
+Money.ca_dollar(100).exchange_to("USD") => Money.us_dollar(80)
+```

data/init.rb

@@ -0,0 +1 @@
+require 'redis-bank'

data/lib/redis-bank.rb

@@ -0,0 +1,152 @@
+require 'money/bank/base'
+
+class Money
+  module Bank
+    # Thrown when an unknown rate format is requested.
+    class UnknownRateFormat < StandardError; end
+
+    # Class for aiding in exchanging money between different currencies. By
+    # default, the +Money+ class uses an object of this class (accessible
+    # through +Money#bank+) for performing currency exchanges.
+    #
+    # @example
+    #   bank = Money::Bank::RedisBank.new redis_client
+    #   bank.add_rate("USD", "CAD", 1.24515)
+    #   bank.add_rate("CAD", "USD", 0.803115)
+    #
+    #   c1 = 100_00.to_money("USD")
+    #   c2 = 100_00.to_money("CAD")
+    #
+    #   # Exchange 100 USD to CAD:
+    #   bank.exchange_with(c1, "CAD") #=> #<Money @cents=1245150>
+    #
+    #   # Exchange 100 CAD to USD:
+    #   bank.exchange_with(c2, "USD") #=> #<Money @cents=803115>
+    class RedisBank < Base
+
+      def initialize(redis_client, &block)
+        super(&block)
+        @redis_client = redis_client
+      end
+
+      # Exchanges the given +Money+ object to a new +Money+ object in
+      # +to_currency+.
+      #
+      # @param  [Money] from
+      #         The +Money+ object to exchange.
+      # @param  [Currency, String, Symbol] to_currency
+      #         The currency to exchange to.
+      #
+      # @yield [n] Optional block to use when rounding after exchanging one
+      #  currency for another.
+      # @yieldparam [Float] n The resulting float after exchanging one currency
+      #  for another.
+      # @yieldreturn [Integer]
+      #
+      # @return [Money]
+      #
+      # @raise +Money::Bank::UnknownRate+ if the conversion rate is unknown.
+      #
+      # @example
+      #   bank = Money::Bank::RedisBank.new redis_client
+      #   bank.add_rate("USD", "CAD", 1.24515)
+      #   bank.add_rate("CAD", "USD", 0.803115)
+      #
+      #   c1 = 100_00.to_money("USD")
+      #   c2 = 100_00.to_money("CAD")
+      #
+      #   # Exchange 100 USD to CAD:
+      #   bank.exchange_with(c1, "CAD") #=> #<Money @cents=1245150>
+      #
+      #   # Exchange 100 CAD to USD:
+      #   bank.exchange_with(c2, "USD") #=> #<Money @cents=803115>
+      def exchange_with(from, to_currency)
+        return from if same_currency?(from.currency, to_currency)
+
+        rate = get_rate(from.currency, to_currency)
+        unless rate
+          raise UnknownRate, "No conversion rate known for '#{from.currency.iso_code}' -> '#{to_currency}'"
+        end
+        _to_currency_  = Currency.wrap(to_currency)
+
+        cents = BigDecimal.new(from.cents.to_s) / (BigDecimal.new(from.currency.subunit_to_unit.to_s) / BigDecimal.new(_to_currency_.subunit_to_unit.to_s))
+
+        ex = cents * BigDecimal.new(rate.to_s)
+        ex = ex.to_f
+        ex = if block_given?
+               yield ex
+             elsif @rounding_method
+               @rounding_method.call(ex)
+             else
+               ex.to_s.to_i
+             end
+        Money.new(ex, _to_currency_)
+      end
+
+      # Registers a conversion rate and returns it (uses +#set_rate+).
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      #
+      # @return [Numeric]
+      #
+      # @example
+      #   bank = Money::Bank::VariableExchange.new
+      #   bank.add_rate("USD", "CAD", 1.24515)
+      #   bank.add_rate("CAD", "USD", 0.803115)
+      def add_rate(from, to, rate)
+        set_rate(from, to, rate)
+      end
+
+      # Set the rate for the given currencies. Uses +Mutex+ to synchronize data
+      # access.
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      #
+      # @return [Numeric]
+      #
+      # @example
+      #   bank = Money::Bank::VariableExchange.new
+      #   bank.set_rate("USD", "CAD", 1.24515)
+      #   bank.set_rate("CAD", "USD", 0.803115)
+      def set_rate(from, to, rate)
+        @redis_client[rate_key_for(from, to)] = rate
+      end
+
+      # Retrieve the rate for the given currencies. Uses +Mutex+ to synchronize
+      # data access.
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      #
+      # @return [Numeric]
+      #
+      # @example
+      #   bank = Money::Bank::VariableExchange.new
+      #   bank.set_rate("USD", "CAD", 1.24515)
+      #   bank.set_rate("CAD", "USD", 0.803115)
+      #
+      #   bank.get_rate("USD", "CAD") #=> 1.24515
+      #   bank.get_rate("CAD", "USD") #=> 0.803115
+      def get_rate(from, to)
+        @redis_client[rate_key_for(from, to)]
+      end
+
+      # Return the rate hashkey for the given currencies.
+      #
+      # @param [Currency, String, Symbol] from The currency to exchange from.
+      # @param [Currency, String, Symbol] to The currency to exchange to.
+      #
+      # @return [String]
+      #
+      # @example
+      #   rate_key_for("USD", "CAD") #=> "USD_TO_CAD"
+      def rate_key_for(from, to)
+        "#{Currency.wrap(from).iso_code}_TO_#{Currency.wrap(to).iso_code}".upcase
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: redis-bank
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Cameron Walsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-08 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: Redis-backed Bank for the Money gem based on the VariableExchangeBank
+email: cameron.walsh@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- init.rb
+- lib/redis-bank.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Redis-backed Bank for the Money gem
+test_files: []
+