fixer 0.3.0 → 0.4

data/.gitignore

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

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2
+rvm --create use 1.9.2@fixer

data/README.md

@@ -1,11 +1,79 @@
 Fixer
 ====
 
-Fixer wraps the current and historical [foreign exchange rate feeds](http://www.ecb.europa.eu/stats/exchange/eurofxref/html/index.en.html) of the European Central Bank.
+Fixer wraps the current and historical
+[foreign exchange rate feeds](http://www.ecb.europa.eu/stats/exchange/eurofxref/html/index.en.html)
+of the European Central Bank.
 
 Usage
 -----
 
-    Fixer.daily
-    Fixer.historical_90
-    Fixer.historical
+```ruby
+Fixer.daily
+Fixer.ninety_days
+Fixer.historical
+```
+
+A sample implementation:
+
+```ruby
+# Migration
+class CreateForeignExchanges < ActiveRecord::Migration
+  def self.up
+    create_table :foreign_exchanges do |t|
+      t.string :iso_code
+      t.float :rate
+
+      t.timestamps
+    end
+
+    add_index :foreign_exchanges, :iso_code
+  end
+
+  def self.down
+    drop_table :foreign_exchanges
+  end
+end
+
+# Model
+class ForeignExchange < ActiveRecord::Base
+  class << self
+    # Returns an exchange rate quote.
+    #
+    # Accepts a counter currency code and an optional base currency code.
+    # Latter defaults to EUR if none is specified.
+    def quote(counter, base='EUR')
+      find_rate_by_currency(counter) / find_rate_by_currency(base)
+    end
+
+    private
+
+    def find_rate_by_currency(iso_code)
+      where(:iso_code => iso_code).first.rate
+    end
+  end
+end
+
+# Bank
+class ECB < Money::Bank::Base
+  class << self
+    def refresh
+      hashes = Fixer.daily.first[:rates]
+      hashes.push({ :currency => "EUR", :rate => 1.0 })
+      hashes.each do |hash|
+        fx = ForeignExchange.find_or_initialize_by_iso_code(hash[:currency])
+        fx.rate = hash[:rate]
+        fx.save
+      end
+    end
+  end
+
+  def exchange_with(from, to_currency)
+    rate = ForeignExchange.quote(to_currency.iso_code, from.currency.iso_code)
+    Money.new((from.cents * rate).floor, to_currency)
+  end
+end
+
+# Initializer
+Money.default_bank = ECB.new
+```

data/Rakefile

@@ -3,7 +3,6 @@ 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

data/fixer.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "fixer"
   s.version     = Fixer::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Hakan Ensari"]
+  s.authors     = ["Paper Cavalier"]
   s.email       = ["code@papercavalier.com"]
   s.homepage    = "http://fixer.heroku.com"
   s.summary     = "A Ruby wrapper to the European Central Bank exchange rate feeds"
@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "fixer"
 
-  s.add_dependency("nokogiri", ["~> 1.4.0"])
-  s.add_development_dependency("rspec", ["~> 2.1.0"])
+  s.add_dependency("nokogiri", ["~> 1.4"])
+  s.add_development_dependency("rspec", ["~> 2.6"])
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/fixer.rb

@@ -1,37 +1,23 @@
-require 'open-uri'
-require 'nokogiri'
+require 'fixer/feed'
+require 'fixer/builder'
 
 module Fixer
-  class << self
-    def daily
-      get('daily')
-    end
+  extend self
 
-    def historical
-      get('hist')
-    end
+  def daily
+    Feed.new('daily').get
+  end
 
-    def historical_90
-      get('hist-90d')
-    end
+  def historical
+    Feed.new('hist').get
+  end
 
-    private
+  def historical_90
+    Kernel.warn("[DEPRECATION] `historical_90` is deprecated.  Please use `ninety_days` instead.")
+    ninety_days
+  end
 
-    def get(type)
-      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']
-            }
-          end
-        }
-      end
-    end
+  def ninety_days
+    Feed.new('hist-90d').get
   end
 end

data/lib/fixer/builder.rb

@@ -0,0 +1,19 @@
+module Fixer
+  class Builder
+    def initialize(node)
+      @node = node
+    end
+
+    def build
+      {
+        :date   => @node['time'],
+        :rates  => @node.xpath('./xmlns:Cube').map do |fx|
+          {
+            :currency => fx['currency'],
+            :rate     => fx['rate']
+          }
+        end
+      }
+    end
+  end
+end

data/lib/fixer/feed.rb

@@ -0,0 +1,27 @@
+require 'nokogiri'
+require 'open-uri'
+
+module Fixer
+  class Feed
+    def initialize(type)
+      @type = type
+    end
+
+    def get
+      doc = Nokogiri::XML(feed)
+      doc.xpath('/gesmes:Envelope/xmlns:Cube/xmlns:Cube', doc.root.namespaces).map do |node|
+        Builder.new(node).build
+      end
+    end
+
+    private
+
+    def feed
+      open(path).read
+    end
+
+    def path
+      "http://www.ecb.europa.eu/stats/eurofxref/eurofxref-#{@type}.xml"
+    end
+  end
+end

data/lib/fixer/version.rb

@@ -1,3 +1,3 @@
 module Fixer
-  VERSION = "0.3.0"
+  VERSION = "0.4"
 end

data/spec/fixer_spec.rb

@@ -1,33 +1,34 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Fixer do
-  it "downloads daily rates" do
-    rates = Fixer.daily
+  describe ".daily" 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
+      rates.size.should eql 1
+      rates.first.should be_a_snapshot
+    end
   end
 
-  it "downloads 90-day historical" do
-    rates = Fixer.historical_90
+  describe ".ninety_days" do
+    it "downloads rates for the past 90 days" do
+      rates = Fixer.ninety_days
 
-    # 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
+      # We should have more than 50 working days in a three-month period
+      rates.size.should > 50
+      rates.each do |rate|
+        rate.should be_a_snapshot
+      end
     end
   end
 
-  it "downloads historical" do
+  it "downloads all rates since January 1st, 1999" 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
+      rate.should be_a_snapshot
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,10 @@
-require "bundler"
+require "bundler/setup"
 require "rspec"
 
 require File.expand_path("../../lib/fixer", __FILE__)
+
+RSpec::Matchers.define :be_a_snapshot do
+  match do |actual|
+    actual.keys.include?(:date) && actual.keys.include?(:rates)
+  end
+end

metadata

@@ -4,17 +4,16 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 0
-  version: 0.3.0
+  - 4
+  version: "0.4"
 platform: ruby
 authors: 
-- Hakan Ensari
+- Paper Cavalier
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-03 00:00:00 +00:00
+date: 2011-07-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +27,7 @@ dependencies:
         segments: 
         - 1
         - 4
-        - 0
-        version: 1.4.0
+        version: "1.4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -42,9 +40,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 2
-        - 1
-        - 0
-        version: 2.1.0
+        - 6
+        version: "2.6"
   type: :development
   version_requirements: *id002
 description: Fixer is a Ruby wrapper to the current and historical foreign exchange or FX rate feeds of the European Central Bank.
@@ -61,12 +58,13 @@ files:
 - .rspec
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - fixer.gemspec
 - lib/fixer.rb
+- lib/fixer/builder.rb
+- lib/fixer/feed.rb
 - lib/fixer/version.rb
 - spec/fixer_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fixer (0.3.0)
-      nokogiri (~> 1.4.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.2)
-    nokogiri (1.4.3.1)
-    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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fixer!
-  nokogiri (~> 1.4.0)
-  rspec (~> 2.1.0)