currency_converter 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--drb

data/README.md

@@ -18,12 +18,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To convert between two currencies:
+
+    CurrencyConverter.exchange("EUR", "USD", 100)
+    => 132.89
+
+    CurrencyConverter.exchange("USD", "EUR", 100)
+    => 75.15
+
+To get the most recent exchange rate between two currencies:
+
+    CurrencyConverter.exchange("EUR", "USD", 1)
+    => 1.33
+
+    CurrencyConverter.exchange("USD", "EUR", 1)
+    => 0.75
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Add tests for it.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+task :test => :spec

data/currency_converter.gemspec

@@ -27,4 +27,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "kramdown", "~> 1.1"
-end
+end

data/lib/currency_converter.rb

@@ -1,3 +1,4 @@
+require "currency_converter/exceptions"
 require "currency_converter/currencies"
 require "currency_converter/version"
 require "net/http"
@@ -22,9 +23,9 @@ module CurrencyConverter
     def exchange(from, to, fixnum)
       @from_currency = from.upcase.to_sym
       @to_currency = to.upcase.to_sym
-      raise StandardError, "Currency #{from_currency} or #{to_currency} is invalid" unless valid_currency?
+      validate_currency
       ex_rate = exchange_rate
-      raise StandardError, "Can't find any exchange rate" if ex_rate.nil?
+      validate_rate(ex_rate)
       value = "%.2f" % (ex_rate.to_f * fixnum).to_s
       value.to_f
     end
@@ -44,11 +45,15 @@ module CurrencyConverter
       raise StandardError, "Please check your internet connection"
     end
 
-    # Check if currency is valid
-    #
-    # Returns true if currency is valid
-    def valid_currency?
-      CurrencyConverter::CURRENCIES.has_key?(from_currency) && CurrencyConverter::CURRENCIES.has_key?(to_currency)
+    # Raise errors for invalid currencies.
+    def validate_currency
+      raise UnknownCurrency.new(from_currency) unless CurrencyConverter::CURRENCIES.has_key?(from_currency)
+      raise UnknownCurrency.new(to_currency) unless CurrencyConverter::CURRENCIES.has_key?(to_currency)
+    end
+
+    # Raise errors for missing data.
+    def validate_rate(rate)
+      raise MissingExchangeRate.new(from_currency, to_currency) if rate.to_f.zero?
     end
   end
-end
+end

data/lib/currency_converter/exceptions.rb

@@ -0,0 +1,19 @@
+module CurrencyConverter
+  # = Missing Exchange Rate
+  #
+  # Raised when the data for a supported currencies is +nil+ or +zero?+.
+  class MissingExchangeRate < StandardError
+    def initialize(from, to)
+      super("Foreign exchange rate from #{from} to #{to} is missing.")
+    end
+  end
+
+  # = Unknown Currency
+  #
+  # Raised when we try to grab data for an unsupported currency code.
+  class UnknownCurrency < StandardError
+    def initialize(currency_code)
+      super("#{currency_code} is not supported.")
+    end
+  end
+end

data/lib/currency_converter/version.rb

@@ -1,3 +1,3 @@
 module CurrencyConverter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/currency_converter_spec.rb

@@ -1,5 +1,22 @@
 require "spec_helper"
 
 describe CurrencyConverter do
-  
-end
+  describe ".exchange" do
+    it "should return the correct rate" do
+      CurrencyConverter.exchange("USD", "USD", 1).should == 1.0
+    end
+  end
+
+  describe "#validate_currency" do
+    describe CurrencyConverter::UnknownCurrency do
+      it 'should raise an error on an unsupported currency code' do
+        expect { CurrencyConverter.exchange("EUR", "UNKNOWN", 100) }.to raise_error(CurrencyConverter::UnknownCurrency)
+        expect { CurrencyConverter.exchange("UNKNOWN", "EUR", 100) }.to raise_error(CurrencyConverter::UnknownCurrency)
+      end
+
+      it 'should not raise an error for supported currency codes' do
+        expect { CurrencyConverter.exchange("EUR", "USD", 100) }.not_to raise_error(CurrencyConverter::UnknownCurrency)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,5 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'rspec'
 require 'currency_converter'
 
 RSpec.configure do |config|
   config.order = "rand"
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: currency_converter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &83669940 !ruby/object:Gem::Requirement
+  requirement: &83208720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *83669940
+  version_requirements: *83208720
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83669730 !ruby/object:Gem::Requirement
+  requirement: &83208520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83669730
+  version_requirements: *83208520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83669450 !ruby/object:Gem::Requirement
+  requirement: &83208240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.14'
   type: :development
   prerelease: false
-  version_requirements: *83669450
+  version_requirements: *83208240
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &83669200 !ruby/object:Gem::Requirement
+  requirement: &83207960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *83669200
+  version_requirements: *83207960
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &83668970 !ruby/object:Gem::Requirement
+  requirement: &83207520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *83668970
+  version_requirements: *83207520
 description: Google provides a web site to converts currencies using exchange rates
   but they have not provided any API for ruby. This is a small library that converts
   currencies exchange rate. You can convert currencies directly through this library.
@@ -76,7 +76,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- CHANGELOG.md
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,6 +84,7 @@ files:
 - currency_converter.gemspec
 - lib/currency_converter.rb
 - lib/currency_converter/currencies.rb
+- lib/currency_converter/exceptions.rb
 - lib/currency_converter/version.rb
 - spec/currency_converter_spec.rb
 - spec/spec_helper.rb
@@ -117,3 +118,4 @@ summary: Google provides a web site to converts currencies using exchange rates
 test_files:
 - spec/currency_converter_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/CHANGELOG.md

@@ -1 +0,0 @@
-== 0.0.1