currency_switcher 0.0.1 → 0.0.2

data/Manifest

@@ -1,3 +1,4 @@
+Manifest
 README.md
 Rakefile
 lib/currency_switcher.rb
@@ -7,4 +8,3 @@ test/helper.rb
 test/html/eur_to_usd.html
 test/html/usd_to_gbp.html
 test/test_currency_switcher.rb
-Manifest

data/README.md

@@ -10,16 +10,31 @@ $ gem install currency_switcher
 
 ## Usage
 
-From the available list of currencies you can create methods in a format specified below and call them on Fixnums:
+There are two ways of using the library:
+
+1) From the available list of currencies you can create methods in a format specified below and call them on Fixnums:
 
 	'from_currency'_to_'to_currency'
 
 For example:
 
 	require 'currency_switcher'
-	3.usd_to_gbp # => converts 3 USD to GBP and returns 1.94
-	15.eur_to_aud # => converts 15 EURO to Australian Dollar and returns 19.61
 	
+	# Convert 3 US Dollars to British Pounds
+	3.usd_to_gbp
+	
+	# Convert 15 Euros to Australian Dollars
+	15.eur_to_aud
+	
+2) Pass currencies as the arguments:
+
+For example:
+
+  require 'currency_switcher'
+  
+  # Convert 3 US Dollars to British Pounds
+  3.exchange("usd", "gbp")
+  
 ## Available Currencies
 
 	aed => United Arab Emirates Dirham

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('currency_switcher', '0.0.1') do |p|
+Echoe.new('currency_switcher', '0.0.2') do |p|
   p.description    = "Convert currencies using exchange rates from http://exchange-rates.org"
   p.url            = "http://github.com/staskie/currency_switcher"
   p.author         = "Dominik Staskiewicz"
   p.email          = "stadominik@gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
-end
+end

data/currency_switcher.gemspec

@@ -2,27 +2,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{currency_switcher}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dominik Staskiewicz"]
   s.cert_chain = ["/Users/dominik/Documents/keys/gem-public_cert.pem"]
-  s.date = %q{2011-01-07}
+  s.date = %q{2011-10-09}
   s.description = %q{Convert currencies using exchange rates from http://exchange-rates.org}
   s.email = %q{stadominik@gmail.com}
   s.extra_rdoc_files = ["README.md", "lib/currency_switcher.rb", "lib/currency_switcher/currencies.rb", "lib/currency_switcher/ext/fixnum.rb"]
-  s.files = ["README.md", "Rakefile", "lib/currency_switcher.rb", "lib/currency_switcher/currencies.rb", "lib/currency_switcher/ext/fixnum.rb", "test/helper.rb", "test/html/eur_to_usd.html", "test/html/usd_to_gbp.html", "test/test_currency_switcher.rb", "Manifest", "currency_switcher.gemspec"]
+  s.files = ["Manifest", "README.md", "Rakefile", "lib/currency_switcher.rb", "lib/currency_switcher/currencies.rb", "lib/currency_switcher/ext/fixnum.rb", "test/helper.rb", "test/html/eur_to_usd.html", "test/html/usd_to_gbp.html", "test/test_currency_switcher.rb", "currency_switcher.gemspec"]
   s.homepage = %q{http://github.com/staskie/currency_switcher}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Currency_switcher", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{currency_switcher}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.signing_key = %q{/Users/dominik/Documents/keys/gem-private_key.pem}
   s.summary = %q{Convert currencies using exchange rates from http://exchange-rates.org}
   s.test_files = ["test/test_currency_switcher.rb"]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/currency_switcher/ext/fixnum.rb

@@ -1,4 +1,20 @@
 class Numeric
+  # Exchange a value using from and to currencies
+  #
+  # from - From currency
+  # to   - To currency
+  #
+  # Example
+  #
+  #   5.exchange("gbp", "usd")
+  #
+  # Returns float value of currency exchange result
+  # Raises StandardError if any currency is invalid
+  # or could not work out the exchange rate
+  def exchange(from, to)
+      CurrencySwitcher.exchange(self, from, to)
+  end
+  
   # Overriding method_missing to add CurrencySwitcher methods
   #
   # sym - standard method_missing argument

data/lib/currency_switcher.rb

@@ -52,11 +52,32 @@ module CurrencySwitcher
   #
   # Returns true if botch currencies are valid or false if one of them is invalid
   def self.both_currencies_valid?
-    CURRENCIES.has_key?(from_currency) && CURRENCIES.has_key?(to_currency)
+    self.from_currency_valid? && self.to_currency_valid?
   end
-  
-  
-  # Calculate the value from fixnum and exchange rate
+
+  # Calculate the value from fixnum, from and to currency
+  #
+  # fixnum - The Fixnum representing how much should be converted
+  # from   - From currency
+  # to     - To currency
+  #
+  # Examples
+  #   CurrencySwitcher.exchange(3,"usd", "gbp")
+  #   # => 5.23
+  #
+  # Returns float value of fixnum multiplied by exchange rate
+  # Raises StandardError if currencies are not valid
+  def self.exchange(fixnum, from, to)
+    @from_currency = from.to_sym
+    @to_currency = to.to_sym
+
+    raise StandardError, "From currency #{from_currency} is invalid" unless self.from_currency_valid?
+    raise StandardError, "To currency #{to_currency} is invalid" unless self.to_currency_valid?
+
+    self.calculate_value(fixnum)
+  end
+
+  # Calculate the value from fixnum
   #
   # fixnum - The Fixnum representing how much should be converted
   #
@@ -98,4 +119,20 @@ module CurrencySwitcher
   def self.currencies
     CURRENCIES.keys.sort.each { |symbol| puts "#{symbol} => #{CURRENCIES[symbol]}"}
   end
+  
+  private 
+  
+  # Check if from currency if valid
+  #
+  # Returns true if from currency if valid
+  def self.from_currency_valid?
+     CURRENCIES.has_key?(from_currency)
+   end
+
+   # Check if to currency is valid
+   #
+   # Returns true if to currency is valid
+   def self.to_currency_valid?
+     CURRENCIES.has_key?(to_currency)
+   end
 end

data/test/test_currency_switcher.rb

@@ -43,12 +43,23 @@ class TestCurrencySwitcher < Test::Unit::TestCase
   end
   
   def test_usd_to_gbp
-    assert_equal(format(2, 0.64539), 2.usd_to_gbp)
-  end
-  
-  def test_eur_to_usd
-    assert_equal(format(3, 1.3171), 3.eur_to_usd)
-  end
+      assert_equal(format(2, 0.64539), 2.usd_to_gbp)
+      assert_equal(format(2, 0.64539), 2.exchange("usd","gbp"))
+    end
+
+
+    def test_eur_to_usd
+      assert_equal(format(3, 1.3171), 3.eur_to_usd)
+      assert_equal(format(3, 1.3171), 3.exchange("eur","usd"))
+    end
+
+    def test_invalid_currency_error
+      assert_raise(StandardError) { 2.exchange("usd","invalid_currency") }
+    end
+
+    def test_argument_error_for_exchange
+      assert_raise(ArgumentError) { 2.exchange("usd") }
+    end
   
   def test_exchange_rate_error
     Nokogiri.stubs(:HTML).returns(nil)

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: currency_switcher
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dominik Staskiewicz
@@ -35,7 +31,7 @@ cert_chain:
   wYwJN5o4GnGcdg==
   -----END CERTIFICATE-----
 
-date: 2011-01-07 00:00:00 +01:00
+date: 2011-10-09 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -51,6 +47,7 @@ extra_rdoc_files:
 - lib/currency_switcher/currencies.rb
 - lib/currency_switcher/ext/fixnum.rb
 files: 
+- Manifest
 - README.md
 - Rakefile
 - lib/currency_switcher.rb
@@ -60,7 +57,6 @@ files:
 - test/html/eur_to_usd.html
 - test/html/usd_to_gbp.html
 - test/test_currency_switcher.rb
-- Manifest
 - currency_switcher.gemspec
 has_rdoc: true
 homepage: http://github.com/staskie/currency_switcher
@@ -81,22 +77,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: currency_switcher
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Convert currencies using exchange rates from http://exchange-rates.org