currency_updater 1.0.0

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem "i18n"
+gem "iso_country_codes"
+gem "yajl-ruby"
+gem "builder",    "~> 2.1.2"
+gem "actionpack", "~> 3.0.3"
+
+group :test, :development do
+  gem "rspec"
+  gem "autotest"
+  gem "autotest-fsevent" if RUBY_PLATFORM =~ /darwin/
+  gem "ruby-debug19"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,76 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.4)
+    autotest-fsevent (0.2.3)
+      sys-uname
+    builder (2.1.2)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.4.2)
+    iso_country_codes (0.2.2)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mocha (0.9.9)
+      rake
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    sys-uname (0.8.4)
+    tzinfo (0.3.23)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0.3)
+  autotest
+  autotest-fsevent
+  builder (~> 2.1.2)
+  i18n
+  iso_country_codes
+  mocha
+  rspec
+  ruby-debug19
+  yajl-ruby

data/README.markdown

@@ -0,0 +1,91 @@
+# Currency Updater
+
+The currency updater loads currency rates based on google search.
+
+## Description
+
+All rates conversions are based on the Euro (EUR).
+This version doesn't use a database.
+
+## Installation
+
+Standalone:
+
+    gem install currency_updater
+
+With bundler:
+
+    gem "currency_updater"
+    
+## Usage
+
+### Fetching Currencies
+
+In order to fetch all currencies defined by ISO 4217:
+
+    currencies = CurrencyUpdater.new
+
+or to fetch only one currency:
+
+    currencies = CurrencyUpdater.new(USD)
+    
+or to fetch some currencies:
+
+    currencies = CurrencyUpdater.new([USD,GBP,RUB])
+    
+### Accessing a currency
+
+To access the currency rate, code or name:
+
+    currencies.usd.rate # => 1.333
+    currencies.usd.code # => "USD"
+    currencies.usd.name # => I18n.t('currency.usd')
+    
+### Output currencies
+
+You're able to convert the currencies into different formats:
+
+    currencies.to_json
+    currencies.to_yaml
+    currencies.to_xml
+
+Have a look at the remote specs to get an idea how the output looks like:
+
+    ruby remote_spec/remote_spec.rb
+
+## Changelog
+
+* 2010-11-19: Initial commit
+
+## Contributors
+
+* Jan Riethmayer (@riethmayer, maintainer)
+
+## Credits
+
+Thanks to [Alex Rabarts](http://statelesssystems.com) for his [iso_country_codes](https://github.com/alexrabarts/iso_country_codes).
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2010 [urbanvention](http://urbanvention.com)
+
+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/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/init.rb

@@ -0,0 +1 @@
+require 'currency_updater'

data/lib/currency_updater/currencies.rb

@@ -0,0 +1,73 @@
+module CurrencyUpdater
+
+  class Currencies
+    # EUR is unsupported because it's our reference currency
+    # TRY is unsupported because it's a method used in actionpack
+    # the other currencies are not supported because of google
+    UNSUPPORTED = %w(EUR TRY AFN ALL AMD AOA AZN BAM BIF BMD BSD BTN CDF CUP ETB FIM FKP GEL GNF GYD IMP JEP KGS KMF LRD LSL LYD MGA MMK MNT MRO MZN SBD SHP SOS STD TJS TMM TOP TVD VUV WST ZWD)
+
+    @@currencies = {}
+
+    class << self
+      def add(currency)
+        currency = currency.to_s.downcase
+        result = @@currencies[currency] = Currency.new(currency)
+        define_currency(currency)
+        result
+      end
+
+      def all
+        @@currencies.values
+      end
+
+      def include?(currency)
+        @@currencies.keys.include?(currency.downcase)
+      end
+
+      def delete
+        @@currencies = {}
+      end
+
+      # for better guessing
+      alias_method :clear, :delete
+
+      def all_codes
+        result = IsoCountryCodes.all.map(&:currency).sort
+        result = result - UNSUPPORTED
+        result.uniq
+      end
+
+      def define_currency(currency)
+        define_method(currency) do
+          @@currencies[currency]
+        end
+      end
+
+      def unsupported?(currency)
+        UNSUPPORTED.include?(currency)
+      end
+    end
+
+    def to_json
+      @@currencies.to_json
+    end
+
+    def to_xml
+      xml = Builder::XmlMarkup.new(:indent=>2)
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      xml.currencies do
+        @@currencies.values.each do |currency|
+          xml.currency(:name => currency.currency) do
+            xml.code(currency.code)
+            xml.rate(currency.rate)
+          end
+        end
+      end
+      xml.target!
+    end
+
+    def to_yaml
+      @@currencies.to_yaml
+    end
+  end
+end

data/lib/currency_updater/currency.rb

@@ -0,0 +1,34 @@
+require 'i18n'
+module CurrencyUpdater
+  class Currency
+    attr_accessor :rate
+    attr_accessor :currency
+    attr_accessor :code
+    def initialize(currency)
+      raise "Need a 3LC for currency #{currency}" unless currency.length == 3
+      @currency = currency
+      @code = currency.upcase
+      @rate = 1.0
+    end
+
+    def name
+      ::I18n.t("currency.#{@currency}")
+    end
+
+    def to_json
+      { :rate => rate,
+        :code => code,
+        :currency => currency }.to_json
+    end
+
+    def to_xml
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      xml.currency(:name => currency) do
+        xml.code(code)
+        xml.rate(rate)
+      end
+      xml.target!
+    end
+  end
+end

data/lib/currency_updater/updater.rb

@@ -0,0 +1,62 @@
+module CurrencyUpdater
+  class Updater
+    class << self
+      def select_country_codes(currency)
+        @@currency_codes = if currency.nil?
+                             Currencies.all_codes
+                           else
+                             Array.new([currency]).flatten
+                           end
+        initialize_currencies
+        update_currencies
+      end
+
+      def initialize_currencies
+        Currencies.clear
+        @@currency_codes.each do |currency|
+          Currencies.add(currency)
+        end
+      end
+
+      def update_currencies
+        currencies = Currencies.all
+        currencies.each do |currency|
+          rate = search_rate_for(currency.code)
+          currency.rate = rate
+        end
+      end
+
+      def search_rate_for(currency)
+        raise "invalid currency" unless currency
+        CurrencyUpdater.rate_finder.call(currency)
+      end
+    end
+    #----------------------------------------------------------------------#
+    # instance methods
+    #----------------------------------------------------------------------#
+    def initialize(currency = nil)
+      @currencies = Currencies.new
+      Updater.select_country_codes(currency)
+    end
+
+    def method_missing(method,*args,&block)
+      if @currencies.respond_to?(method)
+        @currencies.send(method,*args,&block)
+      else
+        super
+      end
+    end
+
+    def to_json
+      @currencies.to_json
+    end
+
+    def to_xml
+      @currencies.to_xml
+    end
+
+    def to_yaml
+      @currencies.to_yaml
+    end
+  end
+end

data/lib/currency_updater.rb

@@ -0,0 +1,30 @@
+require 'iso_country_codes'
+require 'yajl/json_gem'
+require 'builder'
+
+module CurrencyUpdater
+
+  autoload :Currency, 'currency_updater/currency'
+  autoload :Currencies, 'currency_updater/currencies'
+  autoload :Updater, 'currency_updater/updater'
+
+  # Default operation for fetching a currency
+  mattr_accessor :rate_finder
+  @@rate_finder = lambda {|currency|
+    client = Net::HTTP.new("www.google.de")
+    resp = client.get("/search?hl=de&q=1+EUR+to+#{currency}&btnG=Suche&meta=")
+    text_only = resp.body.gsub(/<[^>]*>/, "")
+    match = text_only.match(/1\s+Euro\s+=\s+([0-9\.\s]*)/mix)
+    rate = if match
+             match[1]
+           else
+             warn "currency #{currency} is unsupported"
+             "1.00"
+           end
+    rate.gsub!(/\s+/, "").to_f
+  }
+
+  def self.setup
+    yield self
+  end
+end

data/remote_spec/remote_spec.rb

@@ -0,0 +1,79 @@
+require "rubygems"
+require 'bundler'
+Bundler.setup
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec', 'spec_helper.rb'))
+
+## These test cases will fail because the conversion rate is wrong
+## This is intentionall to let you see some output
+describe "RemoteSpecs" do
+    describe "Fetching only USD" do
+    before :all do
+      @cu = CurrencyUpdater.new("USD")
+    end
+
+    it "should respond to USD" do
+      currency = @cu.usd
+      currency.rate.should_not == 1.000
+      currency.code.should == "USD"
+    end
+  end
+
+  describe "Fetching multiple currencies" do
+    before :all do
+      @cu = CurrencyUpdater.new(["USD", "GBP"])
+    end
+
+    it "should respond to USD" do
+      @cu.usd.rate.should == 1.3333
+    end
+
+    it "should respond to GBP" do
+      @cu.gbp.rate.should == 1.3333
+    end
+
+    it "should not respond to RUB" do
+      lambda {@cu.rub}.should raise_error(NoMethodError)
+    end
+  end
+
+  describe "Output Currencies" do
+    context "to_json" do
+      it "should output one currency" do
+        cu = CurrencyUpdater.new("USD")
+        cu.to_json.should == "{\"usd\":{\"rate\":1.3333,\"code\":\"USD\",\"currency\":\"usd\"}}"
+      end
+
+      it "should output multiple currencies" do
+        cu = CurrencyUpdater.new(["USD", "GBP"])
+        cu.to_json.should == "{\"usd\":{\"rate\":1.3333,\"code\":\"USD\",\"currency\":\"usd\"},\"gbp\":{\"rate\":1.3333,\"code\":\"GBP\",\"currency\":\"gbp\"}}"
+      end
+    end
+
+    context "to_xml" do
+      it "should output one currency" do
+        cu = CurrencyUpdater.new("USD")
+        cu.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<currencies>\n  <currency name=\"usd\">\n    <code>USD</code>\n    <rate>1.3333</rate>\n  </currency>\n</currencies>\n"
+      end
+
+      it "should output multiple currencies" do
+        cu = CurrencyUpdater.new(["USD","GBP"])
+
+        cu.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<currencies>\n  <currency name=\"usd\">\n    <code>USD</code>\n    <rate>1.3333</rate>\n  </currency>\n  <currency name=\"gbp\">\n    <code>GBP</code>\n    <rate>1.3333</rate>\n  </currency>\n</currencies>\n"
+      end
+    end
+
+    context "to_yaml" do
+      it "should output one currency" do
+        cu = CurrencyUpdater.new("USD")
+        cu.to_yaml.should == "--- \nusd: !ruby/object:Currency \n  code: USD\n  currency: usd\n  rate: 1.3333\n"
+      end
+
+      it "should output multiple currencies" do
+        cu = CurrencyUpdater.new(["USD","GBP"])
+
+        cu.to_yaml.should == "--- \nusd: !ruby/object:Currency \n  code: USD\n  currency: usd\n  rate: 1.3333\ngbp: !ruby/object:Currency \n  code: GBP\n  currency: gbp\n  rate: 1.3333\n"
+      end
+    end
+  end
+end

data/spec/currency_updater/currencies_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
+
+module CurrencyUpdater
+  describe Currencies do
+    context "Adding currencies" do
+      before :each do
+        Currencies.delete
+      end
+      it "should add usd" do
+        Currencies.add("USD").should be_instance_of(Currency)
+      end
+      it "should include usd" do
+        Currencies.add("USD")
+        Currencies.should include("USD")
+      end
+      it "should include usd in #all" do
+        Currencies.add("USD")
+        Currencies.all.map(&:code).should include("USD")
+      end
+
+      it "should have no values initially" do
+        Currencies.all.should == []
+      end
+
+      it "should have an xml output" do
+        Currencies.add("USD")
+        Currencies.new.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<currencies>\n  <currency name=\"usd\">\n    <code>USD</code>\n    <rate>1.0</rate>\n  </currency>\n</currencies>\n"
+      end
+    end
+  end
+end

data/spec/currency_updater/updater_spec.rb

@@ -0,0 +1,154 @@
+require File.join(File.dirname(__FILE__), '..','spec_helper.rb')
+
+module CurrencyUpdater
+  describe Updater do
+    # mock the http_access (comment it out to see actual values)
+    def Updater.search_rate_for(foo)
+      return 1.3333
+    end
+
+    describe "Fetching only USD" do
+      before :each do
+        @cu = Updater.new("USD")
+      end
+
+      it "should respond to USD" do
+        currency = @cu.usd
+        currency.rate.should_not == 1.000
+        currency.code.should == "USD"
+      end
+
+      it "should not respond to RUB" do
+        lambda {@cu.rub}.should raise_error(NoMethodError)
+      end
+    end
+
+    describe "Fetching multiple currencies" do
+      before :each do
+        @cu = Updater.new(["USD", "GBP"])
+      end
+
+      it "should respond to USD" do
+        @cu.usd.rate.should == 1.3333
+      end
+
+      it "should respond to GBP" do
+        @cu.gbp.rate.should == 1.3333
+      end
+
+      it "should not respond to RUB" do
+        lambda {@cu.rub}.should raise_error(NoMethodError)
+      end
+    end
+
+    describe "Fetching all currencies" do
+
+      before :each do
+        @cu = Updater.new
+        @codes = Currencies.all_codes
+      end
+
+      # to avoid bad method_missing behaviour
+      it "should not include all" do
+        @codes.should_not include("all")
+      end
+
+      it "should fetch all currencies defined by ISO 4217" do
+        @codes.each do |code|
+          currency = @cu.send code.downcase rescue warn("code #{code} unsupported")
+          currency.should_not be_nil
+        end
+      end
+
+      it "should override all default rates" do
+        @codes.each do |code|
+          currency = @cu.send code.downcase
+          currency.rate.should_not == 1.0000
+        end
+      end
+
+      it "should set all three letter codes properly" do
+        @codes.each do |code|
+          currency = @cu.send code.downcase
+          currency.code.should == code
+        end
+      end
+
+      it "should translate all names" do
+        @codes.each do |code|
+          code_name = code.downcase
+          currency = @cu.send code_name
+          currency.name.should == I18n.t("currency.#{code_name}")
+        end
+      end
+
+      it "should always include USD" do
+        @cu.usd.rate.should == 1.3333
+      end
+
+      it "should always include RUB" do
+        @cu.rub.rate.should == 1.3333
+      end
+
+      it "should always include GBP" do
+        @cu.gbp.rate.should == 1.3333
+      end
+    end
+
+    describe "Output Currencies" do
+      context "to_json" do
+        it "should output one currency" do
+          cu = Updater.new("USD")
+          cu.to_json.should == "{\"usd\":{\"rate\":1.3333,\"code\":\"USD\",\"currency\":\"usd\"}}"
+        end
+
+        it "should output multiple currencies" do
+          cu = Updater.new(["USD", "GBP"])
+          cu.to_json.should == "{\"usd\":{\"rate\":1.3333,\"code\":\"USD\",\"currency\":\"usd\"},\"gbp\":{\"rate\":1.3333,\"code\":\"GBP\",\"currency\":\"gbp\"}}"
+        end
+
+        it "should output all currencies" do
+          cu = Updater.new
+          cu.to_json.should match(/\"rub\":{\"rate\":1\.3333,\"code\":\"RUB\",\"currency\":\"rub\"}/)
+        end
+      end
+
+      context "to_xml" do
+        it "should output one currency" do
+          cu = Updater.new("USD")
+          cu.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<currencies>\n  <currency name=\"usd\">\n    <code>USD</code>\n    <rate>1.3333</rate>\n  </currency>\n</currencies>\n"
+        end
+
+        it "should output multiple currencies" do
+          cu = Updater.new(["USD","GBP"])
+
+          cu.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<currencies>\n  <currency name=\"usd\">\n    <code>USD</code>\n    <rate>1.3333</rate>\n  </currency>\n  <currency name=\"gbp\">\n    <code>GBP</code>\n    <rate>1.3333</rate>\n  </currency>\n</currencies>\n"
+        end
+
+        it "should output all currencies" do
+          cu = Updater.new
+          cu.to_xml.should match(/rub/)
+        end
+      end
+
+      context "to_yaml" do
+        it "should output one currency" do
+          Currencies.clear
+          cu = Updater.new("USD")
+          cu.to_yaml.should == "--- \nusd: !ruby/object:CurrencyUpdater::Currency \n  code: USD\n  currency: usd\n  rate: 1.3333\n"
+        end
+
+        it "should output multiple currencies" do
+          cu = Updater.new(["USD","GBP"])
+
+          cu.to_yaml.should == "--- \nusd: !ruby/object:CurrencyUpdater::Currency \n  code: USD\n  currency: usd\n  rate: 1.3333\ngbp: !ruby/object:CurrencyUpdater::Currency \n  code: GBP\n  currency: gbp\n  rate: 1.3333\n"
+        end
+
+        it "should output all currencies" do
+          cu = Updater.new
+          cu.to_yaml.should match(/rub/)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "rubygems"
+require 'rspec'
+
+gem "actionpack", "3.0.3"
+gem "activemodel", "3.0.3"
+
+require 'active_model'
+require 'action_controller'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib', 'currency_updater')
+require 'currency_updater'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+end
+
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].each { |f| require f }
+I18n.default_locale = :en
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: currency_updater
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jan Riethmayer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-20 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Updating currency rates made easy.
+email: jan@urbanvention.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- init.rb
+- lib/currency_updater.rb
+- lib/currency_updater/currencies.rb
+- lib/currency_updater/currency.rb
+- lib/currency_updater/updater.rb
+- autotest/discover.rb
+- spec/spec_helper.rb
+- spec/currency_updater/currencies_spec.rb
+- spec/currency_updater/updater_spec.rb
+- remote_spec/remote_spec.rb
+has_rdoc: true
+homepage: http://github.com/urbanvention/currency_updater
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Updating currency rates made easy.
+test_files: 
+- autotest/discover.rb
+- spec/spec_helper.rb
+- spec/currency_updater/currencies_spec.rb
+- spec/currency_updater/updater_spec.rb
+- remote_spec/remote_spec.rb