yahoofx 0.0.2 → 0.1.0

data/README.md

@@ -2,7 +2,13 @@
 
 ## Foreign exchange (forex) rate scraper
 
-Gets real time foreign currency exchange rates from Yahoo Finance.
+Gets foreign currency exchange rates from Yahoo Finance.
+
+### Installation
+
+Simply the gem: `gem install yahoofx` 
+
+### Usage
 
 Includes shell command that returns the rate. Usage: yahoofx
 [currency pair]
@@ -10,3 +16,15 @@ Includes shell command that returns the rate. Usage: yahoofx
 E.g. `yahoofx eurusd` outputs 1.2925 if the price of 1 EUR is 1.2925 USD
 
 To use this in your ruby code, this would return the rate as a Float: `Yahoofx::Pair.new(:eur, :usd).bid`
+
+## License
+
+The MIT License (MIT)
+
+Copyright © 2012 Lau Taarnskov
+
+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/bin/yahoofx

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require 'yahoofx'
-raise "Usage: yahoofx [currencypair] eg. yahoofx eurusd" unless ARGV[0].length==6
-p Yahoofx::Pair.new(ARGV[0][0..2], ARGV[0][3..5]).bid
+raise "Usage: yahoofx [currencypair] eg. 'yahoofx eurusd' or 'yahoofx 100 eur in usd'" unless ARGV[0] && (ARGV[0].length==6 || ARGV.join(" ") =~ /in/)
+p Yahoofx::Converter.new.answer(ARGV.join(" "))

data/lib/yahoofx/converter.rb

@@ -0,0 +1,31 @@
+module Yahoofx
+  class Converter
+    def initialize(rate_class = Yahoofx::Pair)
+      @rate_class = rate_class
+    end
+
+    # Either returns a currency rate or converts an amount from one currency to another.
+    # Example to convert currency: "119.99 EUR in USD"
+    # Example to show currency rate: "EURUSD"
+    def answer(p)
+      if p.length==6
+        return @rate_class.new(p[0..2], p[3..5]).bid
+      else
+        convert p
+      end
+    end
+
+    def convert(input_string)
+      parsed = parse(input_string)
+      @rate_class.new(parsed[:from_currency], parsed[:to_currency]).bid*parsed[:from_amount]
+    end
+
+    # Example parameter: 100 EUR in USD
+    def parse(input_string) 
+      arr = input_string.split(/[\p{Space}]+/)
+      { :from_amount => arr[0].to_f,
+        :from_currency => arr[1],
+        :to_currency => arr[3] }
+    end
+  end
+end

data/lib/yahoofx/pair.rb

@@ -1,7 +1,7 @@
 require 'net/http'
 
 module Yahoofx
-  class Pair 
+  class Pair
     # First and second currency code. The parameters could be "USD" and "EUR" for instance
     def initialize(first, second)
       @first, @second = first.to_s, second.to_s
@@ -21,7 +21,7 @@ module Yahoofx
       end
 
       def url_for_currency_pair
-        URI("http://finance.yahoo.com/q?s=#{@first}#{@second}%3Dx&ql=1")
+        URI("http://finance.yahoo.com/q?s=#{@first.downcase}#{@second.downcase}%3Dx&ql=1")
       end
 
       def request_feed

data/lib/yahoofx.rb

@@ -1 +1,2 @@
 require 'yahoofx/pair'
+require 'yahoofx/converter'

data/test/unit/converter_test.rb

@@ -0,0 +1,25 @@
+require_relative "../test_helper"
+
+describe Yahoofx::Converter do
+  before do
+    mock_eur_dkk_bid = MiniTest::Mock.new
+    mock_eur_dkk_bid.expect(:bid, 7.4556)
+    mock_rate_pair_class = MiniTest::Mock.new
+    mock_rate_pair_class.expect(:new, mock_eur_dkk_bid, ['EUR', 'DKK'])
+    @converter = Yahoofx::Converter.new(mock_rate_pair_class)
+  end
+
+  it "should convert amount from one to the other" do
+    assert_equal 745.56, @converter.convert("100 EUR in DKK").to_f
+  end
+
+  describe "when calling answer method" do
+    it "should convert amount when it looks like a conversion" do
+      assert_equal 745.56, @converter.answer("100 EUR in DKK").to_f
+    end
+    
+    it "should show currency rate when two valid currency codes are provided" do
+      assert_equal 7.4556, @converter.answer("EURDKK").to_f
+    end
+  end
+end

data/test/unit/{yahoofx_test.rb → pair_test.rb}

@@ -1,6 +1,6 @@
 require_relative "../test_helper"
 
-describe Yahoofx do
+describe Yahoofx::Pair do
   before do
     page = IO.read(File.dirname(__FILE__) + '/../fixtures/eurusd.html') 
     stub_request(:get, "http://finance.yahoo.com/q?ql=1&s=eurusd=x").

data/yahoofx.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'yahoofx'
-  s.version     = '0.0.2'
+  s.version     = '0.1.0'
   s.executables << 'yahoofx'
   s.summary     = "Gets currency rates from Yahoo Finance"
   s.description = "The gem scrapes Yahoo Finance and returns foreign exchange rates. Also comes with a shell command."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoofx
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-08 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -40,10 +40,12 @@ files:
 - Rakefile
 - bin/yahoofx
 - lib/yahoofx.rb
+- lib/yahoofx/converter.rb
 - lib/yahoofx/pair.rb
 - test/fixtures/eurusd.html
 - test/test_helper.rb
-- test/unit/yahoofx_test.rb
+- test/unit/converter_test.rb
+- test/unit/pair_test.rb
 - yahoofx.gemspec
 homepage: https://github.com/lau/yahoofx
 licenses:
@@ -73,4 +75,5 @@ summary: Gets currency rates from Yahoo Finance
 test_files:
 - test/fixtures/eurusd.html
 - test/test_helper.rb
-- test/unit/yahoofx_test.rb
+- test/unit/converter_test.rb
+- test/unit/pair_test.rb