fixer 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.bundle
+pkg
+*.gem

data/.rspec

@@ -0,0 +1 @@
+-cfd

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 1.9.2
+rvm wrapper 1.9.2

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    fixer (0.2.0)
+      nokogiri (~> 1.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fixer!
+  nokogiri (~> 1.4.0)
+  rake
+  rspec (= 2.0.0.rc)

data/README.markdown

@@ -3,18 +3,28 @@ Fixer
 
 Fixer is a Ruby wrapper to the [current and historical foreign exchange rate feeds provided by the European Central Bank](http://www.ecb.europa.eu/stats/exchange/eurofxref/html/index.en.html).
 
-Implement your own caching.
+I am also throwing in a *minimal* cache. Use if it suits you or implement your own.
+
+Bonus: Use the Money gem.
 
 Usage
 -----
 
-    # Get daily rate
-    Fixer.get('daily')
+    # Download the daily rates.
+    Fixer.daily
+    
+    # Download the 90-day historical rates.
+    Fixer.historical_90
     
-    # Get 90-day historical
-    Fixer.get('hist-90d')
+    # Download all historical rates.
+    Fixer.historical
     
-    # Get historical
-    Fixer.get('hist')
+    # Use the built-in cache.
+    cache = Fixer::Cache
+    cache.to_usd
+    => 1.397
+    cache.base = "EUR"
+    cache.to_eur
+    => 0.7158
     
-    # It doesn't get simpler than this.
+    # It doesn't get any simpler than this.

data/Rakefile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/fixer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fixer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fixer"
+  s.version     = Fixer::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Hakan Ensari"]
+  s.email       = ["code@papercavalier.com"]
+  s.homepage    = "http://fixer.heroku.com"
+  s.summary     = "A Ruby wrapper to the European Central Bank exchange rate feeds"
+  s.description = "Fixer is a Ruby wrapper to the current and historical foreign exchange or FX rate feeds provided by the European Central Bank."
+
+  s.rubyforge_project = "fixer"
+
+  s.add_dependency("nokogiri", ["~> 1.4.0"])
+
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec", ["= 2.0.0.rc"])
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fixer/cache.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+module Fixer
+  class Cache
+    class << self
+      def base
+        @base || "EUR"
+      end
+
+      def base=(name)
+        @base = name
+      end
+
+      def expire
+        @rates = nil
+      end
+
+      def method_missing(sym, *args, &block)
+        if sym.to_s =~ /^to_(.*)$/
+          counter = $1.upcase
+          var_name = "@#{base}_#{counter}".to_sym
+          rate = instance_variable_get(var_name)
+          return rate unless rate.nil?
+
+          rate = quote(counter) / quote(base)
+          rate = (rate * 10000).round.to_f / 10000
+          instance_variable_set(var_name, rate)
+          rate
+        else
+          super
+        end
+      end
+
+      private
+
+      def rates
+        begin
+          @rates ||= Fixer.daily.first[:rates].push({ :currency => "EUR", :rate => "1.0" })
+        rescue
+          raise Error, "Cache not valid"
+        end
+      end
+
+      def quote(counter)
+        rate = rates.detect { |rate| rate[:currency] == counter }
+        raise(Error, "Currency not valid") if rate.nil?
+        rate[:rate].to_f
+      end
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/fixer/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Fixer
-  VERSION = '0.1.1'
+  VERSION = "0.2.0"
 end

data/lib/fixer.rb

@@ -1,10 +1,9 @@
 # encoding: utf-8
 require 'open-uri'
 require 'nokogiri'
+require File.dirname(__FILE__) + '/fixer/cache'
 
 module Fixer
-  BASE_URL = 'http://www.ecb.europa.eu/stats/eurofxref/'
-
   class << self
     def daily
       get('daily')
@@ -17,20 +16,20 @@ module Fixer
     def historical_90
       get('hist-90d')
     end
-      
+
     private
 
     def get(type)
-      url = BASE_URL + "eurofxref-#{type}.xml"
-      feed = open(url).read
-      doc = Nokogiri::XML(feed)
+      path  = "http://www.ecb.europa.eu/stats/eurofxref/eurofxref-#{type}.xml"
+      feed  = open(path).read
+      doc   = Nokogiri::XML(feed)
       doc.xpath('/gesmes:Envelope/xmlns:Cube/xmlns:Cube', doc.root.namespaces).map do |snapshot|
         {
           :date   => snapshot['time'],
           :rates  => snapshot.xpath('./xmlns:Cube').map do |fx|
             {
-              :currency     => fx['currency'],
-              :rate         => fx['rate']
+              :currency => fx['currency'],
+              :rate     => fx['rate']
             }
           end
         }

data/spec/fixer/cache_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module Fixer
+  describe Cache do
+    let(:mock_rates) do
+      [
+        { :currency=>"USD", :rate=>"1.3856" },
+        { :currency=>"JPY", :rate=>"114.98" },
+        { :currency=>"GBP", :rate=>"0.87260" },
+        { :currency=>"CAD", :rate=>"1.4018" },
+        { :currency=>"EUR", :rate=>"1.0" }
+      ]
+    end
+
+    let(:cache) do
+      cache = Fixer::Cache
+      cache.base = "EUR"
+      cache.expire
+      cache
+    end
+
+    it "sets base currency" do
+      cache.base = "USD"
+      cache.base.should eql "USD"
+    end
+
+    it "quotes" do
+      cache.instance_variable_set(:@rates, mock_rates)
+      cache.send(:quote, "USD").should eql 1.3856
+    end
+
+    it "caches" do
+      cache.instance_variable_set(:@rates, "foo")
+      cache.send(:rates).should eql "foo"
+    end
+
+    it "seeds cache" do
+      cache.send(:rates).detect { |rate| rate[:currency] == "USD" }[:rate].should_not be_nil
+    end
+
+    it "expires cache" do
+      cache.instance_variable_set(:@rates, "foo")
+      cache.expire
+      cache.instance_variable_get(:@rates).should be_nil
+    end
+
+    it "raises an error if cache not valid" do
+      Fixer.stub!(:daily).and_return("foo")
+      lambda { cache.send(:rates) }.should raise_error Fixer::Error, "Cache not valid"
+    end
+
+    it "returns an exchange rate" do
+      cache.instance_variable_set(:@rates, mock_rates)
+      cache.to_eur.should eql 1.0
+      cache.to_usd.should eql 1.3856
+
+      cache.base = "GBP"
+      cache.to_gbp.should eql 1.0
+      cache.to_usd.should eql 1.5879
+    end
+
+    it "caches requested exchange rates" do
+      cache.instance_variable_set(:@rates, mock_rates)
+      cache.to_usd
+      cache.instance_variable_get(:@EUR_USD).should eql 1.3856
+    end
+
+    it "raises an error if counter currency not valid" do
+      cache.instance_variable_set(:@rates, mock_rates)
+      lambda { cache.to_foo }.should raise_error Fixer::Error, "Currency not valid"
+    end
+
+    it "raises an error if base currency not valid" do
+      cache.instance_variable_set(:@rates, mock_rates)
+      cache.base = "FOO"
+      lambda { cache.to_usd }.should raise_error Fixer::Error, "Currency not valid"
+    end
+  end
+end

data/spec/fixer_spec.rb

@@ -1,32 +1,31 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe Fixer do
-  context ".download" do
-    it "downloads daily rates" do
-      rates = Fixer.daily
-      rates.size.should eql 1
-      rates.first.should have_key :date
-      rates.first.should have_key :rates
-    end
+  it "downloads daily rates" do
+    rates = Fixer.daily
+    rates.size.should eql 1
+    rates.first.should have_key :date
+    rates.first.should have_key :rates
+  end
 
-    it "downloads 90-day historical" do
-      rates = Fixer.historical_90
-      # We should have more than 50 working days in a three-month period
-      rates.size.should > 50
-      rates.each do |rate|
-        rate.should have_key :date
-        rate.should have_key :rates
-      end
+  it "downloads 90-day historical" do
+    rates = Fixer.historical_90
+    # We should have more than 50 working days in a three-month period
+    rates.size.should > 50
+    rates.each do |rate|
+      rate.should have_key :date
+      rate.should have_key :rates
     end
+  end
 
-    it "downloads historical" do
-      rates = Fixer.historical
-      # We should have a lot of working days in history
-      rates.size.should > 1000
-      rates.each do |rate|
-        rate.should have_key :date
-        rate.should have_key :rates
-      end
+  it "downloads historical" do
+    rates = Fixer.historical
+    # We should have a lot of working days in history
+    rates.size.should > 1000
+    rates.each do |rate|
+      rate.should have_key :date
+      rate.should have_key :rates
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require "rubygems"
 require "bundler/setup"
 require "rspec"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -14,11 +14,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 +01:00
+date: 2010-10-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,10 +31,10 @@ dependencies:
         - 0
         version: 1.4.0
   type: :runtime
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rake
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -43,10 +44,10 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rspec
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -59,7 +60,6 @@ dependencies:
         - rc
         version: 2.0.0.rc
   type: :development
-  prerelease: false
   version_requirements: *id003
 description: Fixer is a Ruby wrapper to the current and historical foreign exchange or FX rate feeds provided by the European Central Bank.
 email: 
@@ -71,10 +71,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/fixer/version.rb
-- lib/fixer.rb
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.markdown
+- Rakefile
+- fixer.gemspec
+- lib/fixer.rb
+- lib/fixer/cache.rb
+- lib/fixer/version.rb
+- spec/fixer/cache_spec.rb
 - spec/fixer_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -82,8 +91,8 @@ homepage: http://fixer.heroku.com
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -91,7 +100,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4559416944163579922
       segments: 
       - 0
       version: "0"
@@ -101,17 +109,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 7
-      version: 1.3.7
+      - 0
+      version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: fixer
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper to the European Central Bank exchange rate feeds
 test_files: 
+- spec/fixer/cache_spec.rb
 - spec/fixer_spec.rb
 - spec/spec_helper.rb