yahoo_finance_currency 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Yahoo Currency 0.1.1
+=====================
+
+Features
+--------
+ - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Shane Emmons
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+Yahoo Currency
+===============
+
+This gem extends Money::Bank::VariableExchange with Money::Bank::YahooCurrency
+and gives you access to the current Yahoo! Finance exchange rates.
+
+Usage
+-----
+
+    require 'money'
+    require 'money/bank/yahoo_currency'
+
+    # set default bank to instance of YahooCurrency
+    Money.default_bank = Money::Bank::YahooCurrency.new
+
+    # create a new money object, and use the standard #exchange_to method
+    n = 1.to_money(:USD)
+    n.exchange_to(:EUR)
+
+An `UnknownRate` will be thrown if `#exchange_to` is called with a `Currency`
+that `Money` knows, but Yahoo! Finance does not.
+
+An `UnknownCurrency` will be thrown if `#exchange_to` is called with a
+`Currency` that `Money` does not know.
+
+Copyright
+---------
+
+See {file:LICENSE} for details.

data/lib/money/bank/yahoo_finance_currency.rb

@@ -0,0 +1,93 @@
+require 'money'
+require 'open-uri'
+
+class Money
+  module Bank
+    class YahooFinanceCurrency < Money::Bank::VariableExchange
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+      ##
+      # Clears all rates stored in @rates
+      #
+      # @return [Hash] The empty @rates Hash.
+      #
+      # @example
+      #   @bank = YahooFinanceCurrency.new  #=> <Money::Bank::YahooFinanceCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   @bank.flush_rates           #=> {}
+      def flush_rates
+        @mutex.synchronize{
+          @rates = {}
+        }
+      end
+
+      ##
+      # Clears the specified rate stored in @rates.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from (used
+      #   for key into @rates).
+      # @param [String, Symbol, Currency] to Currency to convert to (used for
+      #   key into @rates).
+      #
+      # @return [Float] The flushed rate.
+      #
+      # @example
+      #   @bank = YahooFinanceCurrency.new #=> <Money::Bank::YahooFinanceCurrency...>
+      #   @bank.get_rate(:USD, :EUR) #=> 0.776337241
+      #   @bank.flush_rate(:USD, :EUR) #=> 0.776337241
+      def flush_rate(from, to)
+        key = rate_key_for(from, to)
+        @mutex.synchronize{
+          @rates.delete(key)
+        }
+      end
+
+      ##
+      # Returns the requested rate from @rates if it exists, otherwise calls
+      # +#get_yahoo_rate+.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [Float] The requested rate.
+      #
+      # @example
+      #   @bank = YahooFinanceCurrency.new #=> <Money::Bank::YahooFinanceCurrency...>
+      #   @bank.get_rate(:USD, :EUR) #=> 0.776337241
+      def get_rate(from, to)
+        @mutex.synchronize{
+          @rates[rate_key_for(from, to)] ||= get_yahoo_rate(from, to)
+        }
+      end
+
+      ##
+      # Returns the requested rate after querying Yahoo! Finance.
+      #
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [Float] The requested rate.
+      #
+      # @example
+      #   @bank = YahooFinanceCurrency.new #=> <Money::Bank::YahooFinanceCurrency...>
+      #   @bank.get_yahoo_rate(:USD, :EUR) #=> 0.776337241
+      def get_yahoo_rate(from, to)
+        from, to = Currency.wrap(from), Currency.wrap(to)
+
+        if from.iso_code == to.iso_code
+          return 1.0
+        else
+          url = "http://download.finance.yahoo.com/d/quotes.csv?s=#{from.iso_code}#{to.iso_code}=X&f=l1"
+          data = URI.parse(url).read.to_f
+          if data.zero? or to.iso_code == "ALL"
+            raise UnknownRate
+          else
+            return data
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: yahoo_finance_currency
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Vicent Gozalbes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 1
+        - 5
+        version: 3.1.5
+  type: :runtime
+  version_requirements: *id002
+description: YahooFinanceCurrency extends Money::Bank::Base and gives you access to the current Yahoo! Finance exchange rates.
+email: 
+- vicent@peertransfer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- CHANGELOG.md
+files: 
+- lib/money/bank/yahoo_finance_currency.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+has_rdoc: true
+homepage: https://github.com/peertransfer/yahoo_currency
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: ""
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Access the Yahoo! Finance exchange rate data.
+test_files: []
+