currency_spy 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+nbproject
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in currency_spy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    currency_spy (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  currency_spy!
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Lukasz Badura
+
+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.rdoc

@@ -0,0 +1,35 @@
+= CurrencySpy
+
+This is a simple gem composed of simple classes using the Mechanize parser to
+fetch currency rates from various websites. It's main purpose was to collect
+the data for a small bank loan comparison site. I've decided to publish this as
+a standalone gem in case anybody wishes to fetch some rates in their
+application. My classes deal mainly with Polish websites. Feel free to write
+more or request a source.
+
+== Requirements
+
+The gem uses Mechanize to parse sites. I recommend using bundler to easily
+install any dependencies. Please consult the gemspec for a list of
+dependencies (including test and development environment).
+
+== Installation
+
+The plugin can be installed from rubygems:
+  sudo gem install currency_spy
+
+To install the dependencies:
+  bundle
+
+You can also clone my GitHub repository
+(git://github.com/lbadura/currency_spy.git) and build the gem yourself and / or
+hack on it.
+
+== Credits
+
+Feel free to contact me at lukasz@niebo.net.
+My website: http://www.badurowie.org
+
+Copyright (c) 2011 Lukasz Badura. Released under the MIT license.
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/currency_spy.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "currency_spy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "currency_spy"
+  s.version     = CurrencySpy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lukasz Badura"]
+  s.email       = ["lukasz@niebo.net"]
+  s.homepage    = "http://rubygems.org/gems/currency_spy"
+  s.summary     = %q{A gem to fetch currency rates.}
+  s.description = %q{A simple gem to parse and fetch currency rates from different websites.}
+
+  s.rubyforge_project = "currency_spy"
+
+  s.add_development_dependency "rspec"
+  s.add_dependency "mechanize"
+
+  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/currency_spy/nbp.rb

@@ -0,0 +1,50 @@
+module CurrencySpy
+  class Nbp < CurrencySpy::Scraper
+
+    def initialize
+      super
+      @url = 'http://www.nbp.pl/home.aspx?f=/kursy/kursyc.html'
+      @page = parser.get(url)
+    end
+
+    def buy_rate(currency_code = nil)
+      currency_code = @currency_code ||= 'EUR'
+      regexp = Regexp.new(currency_code)
+      @page.search('//tr[@valign="middle"]').each do |tr|
+        tr.search('td').each do |td|
+          if (regexp.match(td.content))
+            return td.next_element.content.sub(',','.').to_f
+          end
+        end
+      end
+      return nil
+    end
+
+    def sell_rate(currency_code = nil)
+      currency_code = @currency_code ||= 'EUR'
+      regexp = Regexp.new(currency_code)
+      @page.search('//tr[@valign="middle"]').each do |tr|
+        tr.search('td').each do |td|
+          if (regexp.match(td.content))
+            return td.next_element.next_element.content.sub(',','.').to_f
+          end
+        end
+      end
+      return nil
+    end
+
+    def rate_time
+      regexp = Regexp.new(/\d\d\d\d-\d\d-\d\d/)
+      res = nil
+      @page.search('//p[@class="nag"]').each do |p|
+        p.search('b').each do |b|
+          if (regexp.match(b.content))
+            res = b.content
+          end
+        end
+      end
+      return DateTime.strptime(res, "%Y-%m-%d")
+    end
+
+  end
+end

data/lib/currency_spy/scraper.rb

@@ -0,0 +1,39 @@
+module CurrencySpy
+  class Scraper
+    AVAILABLE_CODES = ['EUR', 'CHF', 'GBP'].freeze
+    attr_accessor :url, :currency_code
+    attr_reader :available_codes, :parser
+    def initialize()
+      @parser = Mechanize.new
+      @url = nil
+    end
+
+    def fetch_rates(currency_code = 'EUR')
+      if self.class.superclass.eql?(Object)
+        raise Exception.new("This method should be invoked from CurrencySpy::Scraper sub class")
+      else
+        if AVAILABLE_CODES.include?(currency_code)
+          @currency_code = currency_code
+          return {:buy_rate => buy_rate, :sell_rate => sell_rate, :rate_time => rate_time}
+        else
+          raise Exception.new("Unsupported currency code: #{currency_code}")
+        end
+      end
+    end
+
+    def buy_rate
+      # This method should be defined in a sub class
+      raise NotImplementedError
+    end
+
+    def sell_rate
+      # This method should be defined in a sub class
+      raise NotImplementedError
+    end
+
+    def rate_time
+      # This method should be defined in a sub class
+      raise NotImplementedError
+    end
+  end
+end

data/lib/currency_spy/version.rb

@@ -0,0 +1,3 @@
+module CurrencySpy
+  VERSION = "0.0.1"
+end

data/lib/currency_spy.rb

@@ -0,0 +1,12 @@
+$:.unshift File.dirname(__FILE__)
+require 'mechanize'
+require 'currency_spy/scraper'
+require 'currency_spy/nbp'
+
+module CurrencySpy
+  DATE_FORMAT = "%d-%m-%Y"
+
+  def self.datestr(date)
+    return date.strftime(CurrencySpy::DATE_FORMAT)
+  end
+end

data/spec/nbp_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe "A Nbp scraper instance" do
+  before :each do
+    @scraper = CurrencySpy::Nbp.new
+  end
+
+  it "should have a proper url defined" do
+    @scraper.url.should == 'http://www.nbp.pl/home.aspx?f=/kursy/kursyc.html'
+  end
+
+  it "should return currency values" do
+    @scraper.fetch_rates.should_not be_nil
+    @scraper.fetch_rates.length.should == 3
+    @scraper.buy_rate.should == @scraper.fetch_rates[:buy_rate]
+    @scraper.sell_rate.should == @scraper.fetch_rates[:sell_rate]
+  end
+
+  it "should return a buy rate smaller than the sell rate" do
+    @scraper.buy_rate.should < @scraper.sell_rate
+  end
+
+  it "should return buy rate as a float" do
+    @scraper.fetch_rates[:buy_rate].should be_a_kind_of(Float)
+  end
+
+  it "should return sell rate as a float" do
+    @scraper.fetch_rates[:sell_rate].should be_a_kind_of(Float)
+  end
+  
+  it "should return rate time as a DateTime instance" do
+    @scraper.fetch_rates[:rate_time].should be_a_kind_of(DateTime)
+  end
+end

data/spec/scraper_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe "A Scraper class" do
+  it "Should have a list of available currency codes" do
+    CurrencySpy::Scraper::AVAILABLE_CODES.should_not be_empty
+  end
+end
+
+describe "An instance of scraper" do
+  before :each do
+    @scraper = CurrencySpy::Scraper.new
+  end
+
+  it "should raise an exception if fetch_rate is called on Scraper class instance" do
+    lambda {@scraper.fetch_rates("XYZ")}.should raise_error(Exception, "This method should be invoked from CurrencySpy::Scraper sub class")
+  end
+
+  it "should raise an exception if an abstract method is called" do
+    lambda {@scraper.buy_rate}.should raise_error(NotImplementedError)
+    lambda {@scraper.sell_rate}.should raise_error(NotImplementedError)
+    lambda {@scraper.rate_time}.should raise_error(NotImplementedError)
+  end
+
+  it "should allow to read the mechanize parser" do
+    @scraper.parser.should_not be_nil
+    @scraper.parser.should be_a_kind_of Mechanize
+  end
+
+  it "should assign default properties" do
+    @scraper.url.should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'currency_spy'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: currency_spy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Lukasz Badura
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-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: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A simple gem to parse and fetch currency rates from different websites.
+email: 
+- lukasz@niebo.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- currency_spy.gemspec
+- lib/currency_spy.rb
+- lib/currency_spy/nbp.rb
+- lib/currency_spy/scraper.rb
+- lib/currency_spy/version.rb
+- spec/nbp_spec.rb
+- spec/scraper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/currency_spy
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: currency_spy
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A gem to fetch currency rates.
+test_files: 
+- spec/nbp_spec.rb
+- spec/scraper_spec.rb
+- spec/spec_helper.rb