google_currency_rails_cache 1.0.0

data/AUTHORS

@@ -0,0 +1,8 @@
+andersonbrandon
+Donald Ball
+James Chen
+Jérémy Lecour
+Lars Pind
+Shane Emmons
+sowenjub
+Alex Kremer

data/CHANGELOG.md

@@ -0,0 +1,107 @@
+Google Currency 2.2.0
+=====================
+
+- Update money dependency to ~> 5.1.0
+
+Google Currency 2.1.0
+=====================
+
+- Update money dependency to ~> 5.0.0
+
+Google Currency 2.0.2
+=====================
+
+Bugfixes
+--------
+ - Fix encoding issue
+
+Google Currency 2.0.1
+=====================
+
+Features
+--------
+ - Handles funky exchange rates (Arnaud Joubay)
+
+Bugfixes
+--------
+ - Fix for running under 1.9.2 in TextMate (larspind)
+
+Google Currency 2.0.0
+=====================
+
+Features
+--------
+ - Added multi_json to allow users to select their own JSON parsing engine.
+ - Removed deprecated method #get_google_rate.
+
+Bugfixes
+--------
+ - Updated deprecated rake tasks
+
+Google Currency 1.1.1
+=====================
+
+Bugfixes
+--------
+ - Built gem using Ruby 1.8.7 to bypass a known error with RubyGems 1.5.0 and
+   Ruby 1.9.2
+
+Google Currency 1.1.0
+=====================
+
+Features
+--------
+ - Deprecated #get_google_rate, use #get_rate (thanks RMU Alumni)
+
+Bugfixes
+---------
+ - Fixed an issue when rates over 1000 did not parse correctly (thanks Brandon
+   Anderson)
+
+Google Currency 1.0.3
+=====================
+
+Features
+--------
+ - Update `money` requirement to `~> 3.5`
+
+Google Currency 1.0.2
+=====================
+
+Features
+--------
+ - Replace `eval` with `JSON.parse`
+ - Use BigDecimal instead of Float
+
+Bugfixes
+--------
+ - Quell parenthetical warnings in specs
+
+Google Currency 1.0.1
+=====================
+
+Features
+--------
+ - Update `money` requirement to `~> 3.1.5`
+
+Google Currency 1.0.0
+=====================
+
+Features
+--------
+ - Updated `money` requirement to `~> 3.1.0`
+
+Google Currency 0.1.1
+=====================
+
+Features
+--------
+ - Added #flush_rates
+ - Added #flush_rate
+
+Google Currency 0.1.0
+=====================
+
+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,39 @@
+Google Currency with Rails Cache
+================================
+
+This gem extends Money::Bank::VariableExchange with Money::Bank::GoogleCurrency
+and gives you access to the current Google Currency exchange rates.
+
+You have to load one of the JSON libraries supported by
+[MultiJSON](https://github.com/intridea/multi_json) (`json` for example)
+if it's not already loaded by your application. In a Rails application,
+ActiveSupport provides a JSON implementation that is automatically recognized.
+
+This fork of the original GoogleCurrency library uses the Rails.cache for exchange rate
+storage instead of a Mutex. It is designed for multiple application server environments.
+
+Usage
+-----
+
+    require 'money'
+    require 'money/bank/google_currency'
+    require 'json'
+    MultiJson.engine = :json_gem # or :yajl
+
+    # set default bank to instance of GoogleCurrency
+    Money.default_bank = Money::Bank::GoogleCurrency.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 Google does not.
+
+An `UnknownCurrency` will be thrown if `#exchange_to` is called with a
+`Currency` that `Money` does not know.
+
+Copyright
+---------
+
+Original Google Currency work is Copyright (c) 2011 Shane Emmons. See {file:LICENSE} for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake/clean'
+
+CLOBBER.include('.yardoc', 'doc')
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("../google_currency.gemspec", __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  task(:spec){abort "`gem install rspec` to run specs"}
+end
+task :default => :spec
+task :test => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options << "--files" << "CHANGELOG.md,LICENSE"
+  end
+rescue LoadError
+  task(:yard){abort "`gem install yard` to generate documentation"}
+end
+
+begin
+  require 'rubygems/package_task'
+  Gem::PackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+  task :gem => :gemspec
+rescue LoadError
+  task(:gem){abort "`gem install rake` to package gems"}
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh "gem install pkg/#{gemspec.full_name}.gem"
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/google_currency_rails_cache.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name        = "google_currency_rails_cache"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Shane Emmons", "Alex Kremer"]
+  s.email       = ["semmons99@gmail.com", "alex@flextrip.com"]
+  s.homepage    = "http://github.com/flextrip/google_currency_rails_cache"
+  s.summary     = "Access the Google Currency exchange rate data."
+  s.description = "GoogleCurrency extends Money::Bank::Base and gives you access to the current Google Currency exchange rates. This fork allows caching of exchange rate data in Rails.cache and removes the necessity for the Mutex."
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "yard", ">= 0.5.8"
+  s.add_development_dependency "json", ">= 1.4.0"
+  s.add_development_dependency "yajl-ruby", ">= 1.0.0"
+  s.add_development_dependency "ffi"
+
+  s.add_dependency "money", "~> 5.1.0"
+  s.add_dependency "multi_json", ">= 1.0.0"
+  s.add_dependency "rails", "> 3.2"
+
+  s.files =  Dir.glob("{lib,spec}/**/*")
+  s.files += %w(LICENSE README.md CHANGELOG.md AUTHORS)
+  s.files += %w(Rakefile .gemtest google_currency_rails_cache.gemspec)
+
+  s.require_path = "lib"
+end

data/lib/money/bank/google_currency_rails_cache.rb

@@ -0,0 +1,169 @@
+require 'money'
+require 'open-uri'
+require 'multi_json'
+
+class Money
+  module Bank
+    class GoogleCurrencyRailsCache < Money::Bank::VariableExchange
+
+      SERVICE_HOST = "www.google.com"
+      SERVICE_PATH = "/ig/calculator"
+
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+      ##
+      # Clears all rates stored in @rates
+      #
+      # @return [Hash] The empty @rates Hash.
+      #
+      # @example
+      #   @bank = GoogleCurrency.new  #=> <Money::Bank::GoogleCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   @bank.flush_rates           #=> {}
+      def flush_rates
+        @rates.keys.each do |rate_key|
+          Rails.cache.delete "exchange_rate/#{rate_key}"
+        end
+        @rates.clear
+      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 = GoogleCurrency.new    #=> <Money::Bank::GoogleCurrency...>
+      #   @bank.get_rate(:USD, :EUR)    #=> 0.776337241
+      #   @bank.flush_rate(:USD, :EUR)  #=> 0.776337241
+      def flush_rate(from, to)
+        rate_key = rate_key_for(from, to)
+        Rails.cache.delete "exchange_rate/#{rate_key}"
+        @rates.delete(rate_key)
+      end
+
+      ##
+      # Returns the requested 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 = GoogleCurrency.new  #=> <Money::Bank::GoogleCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      def get_rate(from, to)
+          @rates[rate_key_for(from, to)] ||= Rails.cache.fetch("exchange_rate/#{rate_key_for(from, to)}", :expires_in => 12.hours ) {
+            fetch_rate(from, to) 
+          }
+      end
+
+      private
+
+      ##
+      # Queries for the requested rate and returns it.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [BigDecimal] The requested rate.
+      def fetch_rate(from, to)
+        from, to = Currency.wrap(from), Currency.wrap(to)
+
+        data = build_uri(from, to).read
+        data = fix_response_json_data(data)
+
+        error = data['error']
+        raise UnknownRate unless error == '' || error == '0'
+        decode_rate data['rhs']
+      end
+
+      ##
+      # Build a URI for the given arguments.
+      #
+      # @param [Currency] from The currency to convert from.
+      # @param [Currency] to The currency to convert to.
+      #
+      # @return [URI::HTTP]
+      def build_uri(from, to)
+        uri = URI::HTTP.build(
+          :host  => SERVICE_HOST,
+          :path  => SERVICE_PATH,
+          :query => "hl=en&q=1#{from.iso_code}%3D%3F#{to.iso_code}"
+        )
+      end
+
+      ##
+      # Takes the invalid JSON returned by Google and fixes it.
+      #
+      # @param [String] data The JSON string to fix.
+      #
+      # @return [Hash]
+      def fix_response_json_data(data)
+        data.gsub!(/lhs:/, '"lhs":')
+        data.gsub!(/rhs:/, '"rhs":')
+        data.gsub!(/error:/, '"error":')
+        data.gsub!(/icc:/, '"icc":')
+        data.gsub!(Regexp.new("(\\\\x..|\\\\240)"), '')
+
+        MultiJson.decode(data)
+      end
+
+      ##
+      # Takes the 'rhs' response from Google and decodes it.
+      #
+      # @param [String] rhs The google rate string to decode.
+      #
+      # @return [BigDecimal]
+      def decode_rate(rhs)
+        if complex_rate?(rhs)
+          decode_complex_rate(rhs)
+        else
+          decode_basic_rate(rhs)
+        end
+      end
+
+      ##
+      # Takes the 'rhs' response from Google and decides if it's a complex rate
+      #
+      # @param [String] rhs The google rate string to check.
+      #
+      # @return [Boolean]
+      def complex_rate?(rhs)
+        rhs.match(/10x3csupx3e(-?\d+)x3c\/supx3e/)
+      end
+
+      ##
+      # Takes a complex 'rhs' response from Google and converts it to a numeric
+      # rate.
+      #
+      # @param [String] rhs The complex google rate string to convert.
+      #
+      # @return [BigDecimal]
+      def decode_complex_rate(rhs)
+        rate  = BigDecimal(rhs.match(/\d[\d\s]*\.?\d*/)[0])
+        power = rhs.match(/10x3csupx3e(-?\d+)x3c\/supx3e/)
+
+        rate * 10**power[1].to_i
+      end
+
+      ##
+      # Takes a basic 'rhs' response from Google and converts it to a numeric
+      # rate.
+      #
+      # @param [String] rhs The basic google rate string to convert.
+      #
+      # @return [BigDecimal]
+      def decode_basic_rate(rhs)
+        BigDecimal(rhs.gsub(/[^\d\.]/, ''))
+      end
+    end
+  end
+end

data/spec/google_currency_with_json_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'money'
+require 'money/bank/google_currency_rails_cache'
+require 'rails'
+
+require 'json'
+MultiJson.engine = :json_gem
+
+describe "GoogleCurrency" do
+  
+  before :each do
+    Rails.stub(:cache).and_return(ActiveSupport::Cache::MemoryStore.new)
+    @bank = Money::Bank::GoogleCurrencyRailsCache.new
+  end
+
+  describe "#get_rate" do
+    it "should use #fetch_rate when rate is unknown" do
+      @bank.should_receive(:fetch_rate).once
+      @bank.get_rate('USD', 'USD')
+    end
+
+    it "should not use #fetch_rate when rate is known" do
+      @bank.get_rate('USD', 'USD')
+      @bank.should_not_receive(:fetch_rate)
+      @bank.get_rate('USD', 'USD')
+    end
+
+    it "should return the correct rate" do
+      @bank.get_rate('USD', 'USD').should == 1.0
+    end
+
+    it "should store the rate for faster retreival" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.rates.should include('USD_TO_EUR')
+    end
+
+    it "should handle complex rates" do
+      uri = double('uri')
+      @bank.stub(:build_uri){|from,to| uri }
+      uri.stub(:read) { %q({lhs: "1 Vietnamese dong",rhs: "4.8 \x26#215; 10\x3csup\x3e-5\x3c/sup\x3e U.S. dollars",error: "",icc: true}) }
+
+      @bank.get_rate('VND', 'USD').should == BigDecimal("0.48215105E1")
+    end
+  end
+
+  describe "#flush_rates" do
+    it "should empty @rates" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.flush_rates
+      @bank.rates.should == {}
+    end
+  end
+
+  describe "#flush_rate" do
+    it "should remove a specific rate from @rates" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.get_rate('USD', 'JPY')
+      @bank.flush_rate('USD', 'EUR')
+      @bank.rates.should include('USD_TO_JPY')
+      @bank.rates.should_not include('USD_TO_EUR')
+    end
+  end
+end

data/spec/google_currency_with_yajl_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'money'
+require 'money/bank/google_currency_rails_cache'
+
+require 'rails'
+
+require 'yajl'
+MultiJson.engine = :yajl
+
+describe "GoogleCurrency" do
+  before :each do
+    Rails.stub(:cache).and_return(ActiveSupport::Cache::MemoryStore.new)
+    @bank = Money::Bank::GoogleCurrencyRailsCache.new
+  end
+
+  describe "#get_rate" do
+    it "should use #fetch_rate when rate is unknown" do
+      @bank.should_receive(:fetch_rate).once
+      @bank.get_rate('USD', 'USD')
+    end
+
+    it "should not use #fetch_rate when rate is known" do
+      @bank.get_rate('USD', 'USD')
+      @bank.should_not_receive(:fetch_rate)
+      @bank.get_rate('USD', 'USD')
+    end
+
+    it "should return the correct rate" do
+      @bank.get_rate('USD', 'USD').should == 1.0
+    end
+
+    it "should store the rate for faster retreival" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.rates.should include('USD_TO_EUR')
+    end
+
+    it "should handle complex rates" do
+      uri = double('uri')
+      @bank.stub(:build_uri){|from,to| uri }
+      uri.stub(:read) { %q({lhs: "1 Vietnamese dong",rhs: "4.8 \x26#215; 10\x3csup\x3e-5\x3c/sup\x3e U.S. dollars",error: "",icc: true}) }
+      @bank.get_rate('VND', 'USD').should == BigDecimal("0.48215105E1")
+    end
+  end
+
+  describe "#flush_rates" do
+    it "should empty @rates" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.flush_rates
+      @bank.rates.should == {}
+    end
+  end
+
+  describe "#flush_rate" do
+    it "should remove a specific rate from @rates" do
+      @bank.get_rate('USD', 'EUR')
+      @bank.get_rate('USD', 'JPY')
+      @bank.flush_rate('USD', 'EUR')
+      @bank.rates.should include('USD_TO_JPY')
+      @bank.rates.should_not include('USD_TO_EUR')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: google_currency_rails_cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Shane Emmons
+- Alex Kremer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: GoogleCurrency extends Money::Bank::Base and gives you access to the
+  current Google Currency exchange rates. This fork allows caching of exchange rate
+  data in Rails.cache and removes the necessity for the Mutex.
+email:
+- semmons99@gmail.com
+- alex@flextrip.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/money/bank/google_currency_rails_cache.rb
+- spec/google_currency_with_json_spec.rb
+- spec/google_currency_with_yajl_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+- AUTHORS
+- Rakefile
+- .gemtest
+- google_currency_rails_cache.gemspec
+homepage: http://github.com/flextrip/google_currency_rails_cache
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Access the Google Currency exchange rate data.
+test_files: []
+has_rdoc: