currency_exchange 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => [:spec]

data/currency_exchange.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "currency_exchange/version"
+
+Gem::Specification.new do |s|
+  s.name        = "currency_exchange"
+  s.version     = CurrencyExchange::VERSION
+  s.authors     = ["Thil Bandara"]
+  s.email       = ["tbandara@gmail.com"]
+  s.homepage    = "https://github.com/thil/currency_exchange"
+  s.summary     = %q{A basic library to retrieve and convert currency}
+  s.description = %q{A basic library to retrieve and convert currency}
+
+  s.rubyforge_project = "currency_exchange"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "json"
+  s.add_runtime_dependency "activesupport", ">= 3.2.0"
+  s.add_runtime_dependency "rails", ">= 3.2.0"
+end

data/lib/currency_exchange/data/currencies.rb

@@ -0,0 +1,176 @@
+module CurrencyExchange
+  module Data
+    class Currencies 
+
+      def self.has_currency?(from, to)
+        return false unless from && to
+        CURRENCIES.has_key?(from.upcase) && CURRENCIES.has_key?(to.upcase)
+      end
+
+      private 
+
+      CURRENCIES = {
+        "AED"=> "United Arab Emirates Dirham",
+        "AFN"=> "Afghan Afghani",
+        "ALL"=> "Albanian Lek",
+        "AMD"=> "Armenian Dram",
+        "ANG"=> "Netherlands Antillean Guilder",
+        "AOA"=> "Angolan Kwanza",
+        "ARS"=> "Argentine Peso",
+        "AUD"=> "Australian Dollar",
+        "AWG"=> "Aruban Florin",
+        "AZN"=> "Azerbaijani Manat",
+        "BAM"=> "Bosnia-Herzegovina Convertible Mark",
+        "BBD"=> "Barbadian Dollar",
+        "BDT"=> "Bangladeshi Taka",
+        "BGN"=> "Bulgarian Lev",
+        "BHD"=> "Bahraini Dinar",
+        "BIF"=> "Burundian Franc",
+        "BMD"=> "Bermudan Dollar",
+        "BND"=> "Brunei Dollar",
+        "BOB"=> "Bolivian Boliviano",
+        "BRL"=> "Brazilian Real",
+        "BSD"=> "Bahamian Dollar",
+        "BTN"=> "Bhutanese Ngultrum",
+        "BWP"=> "Botswanan Pula",
+        "BYR"=> "Belarusian Ruble",
+        "BZD"=> "Belize Dollar",
+        "CAD"=> "Canadian Dollar",
+        "CDF"=> "Congolese Franc",
+        "CHF"=> "Swiss Franc",
+        "CLF"=> "Chilean Unit of Account (UF)",
+        "CLP"=> "Chilean Peso",
+        "CNY"=> "Chinese Yuan",
+        "COP"=> "Colombian Peso",
+        "CRC"=> "Costa Rican Colon",
+        "CUP"=> "Cuban Peso",
+        "CVE"=> "Cape Verdean Escudo",
+        "CZK"=> "Czech Republic Koruna",
+        "DJF"=> "Djiboutian Franc",
+        "DKK"=> "Danish Krone",
+        "DOP"=> "Dominican Peso",
+        "DZD"=> "Algerian Dinar",
+        "EGP"=> "Egyptian Pound",
+        "ETB"=> "Ethiopian Birr",
+        "EUR"=> "Euro",
+        "FJD"=> "Fijian Dollar",
+        "FKP"=> "Falkland Islands Pound",
+        "GBP"=> "British Pound Sterling",
+        "GEL"=> "Georgian Lari",
+        "GHS"=> "Ghanaian Cedi",
+        "GIP"=> "Gibraltar Pound",
+        "GMD"=> "Gambian Dalasi",
+        "GNF"=> "Guinean Franc",
+        "GTQ"=> "Guatemalan Quetzal",
+        "GYD"=> "Guyanaese Dollar",
+        "HKD"=> "Hong Kong Dollar",
+        "HNL"=> "Honduran Lempira",
+        "HRK"=> "Croatian Kuna",
+        "HTG"=> "Haitian Gourde",
+        "HUF"=> "Hungarian Forint",
+        "IDR"=> "Indonesian Rupiah",
+        "IEP"=> "Irish Pound",
+        "ILS"=> "Israeli New Sheqel",
+        "INR"=> "Indian Rupee",
+        "IQD"=> "Iraqi Dinar",
+        "IRR"=> "Iranian Rial",
+        "ISK"=> "Icelandic Krona",
+        "JMD"=> "Jamaican Dollar",
+        "JOD"=> "Jordanian Dinar",
+        "JPY"=> "Japanese Yen",
+        "KES"=> "Kenyan Shilling",
+        "KGS"=> "Kyrgystani Som",
+        "KHR"=> "Cambodian Riel",
+        "KMF"=> "Comorian Franc",
+        "KPW"=> "North Korean Won",
+        "KRW"=> "South Korean Won",
+        "KWD"=> "Kuwaiti Dinar",
+        "KZT"=> "Kazakhstani Tenge",
+        "LAK"=> "Laotian Kip",
+        "LBP"=> "Lebanese Pound",
+        "LKR"=> "Sri Lankan Rupee",
+        "LRD"=> "Liberian Dollar",
+        "LSL"=> "Lesotho Loti",
+        "LTL"=> "Lithuanian Litas",
+        "LVL"=> "Latvian Lats",
+        "LYD"=> "Libyan Dinar",
+        "MAD"=> "Moroccan Dirham",
+        "MDL"=> "Moldovan Leu",
+        "MGA"=> "Malagasy Ariary",
+        "MKD"=> "Macedonian Denar",
+        "MMK"=> "Myanma Kyat",
+        "MNT"=> "Mongolian Tugrik",
+        "MOP"=> "Macanese Pataca",
+        "MRO"=> "Mauritanian Ouguiya",
+        "MUR"=> "Mauritian Rupee",
+        "MVR"=> "Maldivian Rufiyaa",
+        "MWK"=> "Malawian Kwacha",
+        "MXN"=> "Mexican Peso",
+        "MYR"=> "Malaysian Ringgit",
+        "MZN"=> "Mozambican Metical",
+        "NAD"=> "Namibian Dollar",
+        "NGN"=> "Nigerian Naira",
+        "NIO"=> "Nicaraguan Cordoba",
+        "NOK"=> "Norwegian Krone",
+        "NPR"=> "Nepalese Rupee",
+        "NZD"=> "New Zealand Dollar",
+        "OMR"=> "Omani Rial",
+        "PAB"=> "Panamanian Balboa",
+        "PEN"=> "Peruvian Nuevo Sol",
+        "PGK"=> "Papua New Guinean Kina",
+        "PHP"=> "Philippine Peso",
+        "PKR"=> "Pakistani Rupee",
+        "PLN"=> "Polish Zloty",
+        "PYG"=> "Paraguayan Guarani",
+        "QAR"=> "Qatari Rial",
+        "RON"=> "Romanian Leu",
+        "RSD"=> "Serbian Dinar",
+        "RUB"=> "Russian Ruble",
+        "RWF"=> "Rwandan Franc",
+        "SAR"=> "Saudi Riyal",
+        "SBD"=> "Solomon Islands Dollar",
+        "SCR"=> "Seychellois Rupee",
+        "SDG"=> "Sudanese Pound",
+        "SEK"=> "Swedish Krona",
+        "SGD"=> "Singapore Dollar",
+        "SHP"=> "Saint Helena Pound",
+        "SLL"=> "Sierra Leonean Leone",
+        "SOS"=> "Somali Shilling",
+        "SRD"=> "Surinamese Dollar",
+        "STD"=> "Sao Tome and Principe Dobra",
+        "SVC"=> "Salvadoran Colon",
+        "SYP"=> "Syrian Pound",
+        "SZL"=> "Swazi Lilangeni",
+        "THB"=> "Thai Baht",
+        "TJS"=> "Tajikistani Somoni",
+        "TMT"=> "Turkmenistani Manat",
+        "TND"=> "Tunisian Dinar",
+        "TOP"=> "Tongan Pa anga",
+        "TRY"=> "Turkish Lira",
+        "TTD"=> "Trinidad and Tobago Dollar",
+        "TWD"=> "New Taiwan Dollar",
+        "TZS"=> "Tanzanian Shilling",
+        "UAH"=> "Ukrainian Hryvnia",
+        "UGX"=> "Ugandan Shilling",
+        "USD"=> "United States Dollar",
+        "UYU"=> "Uruguayan Peso",
+        "UZS"=> "Uzbekistan Som",
+        "VEF"=> "Venezuelan Bolivar",
+        "VND"=> "Vietnamese Dong",
+        "VUV"=> "Vanuatu Vatu",
+        "WST"=> "Samoan Tala",
+        "XAF"=> "CFA Franc BEAC",
+        "XCD"=> "East Caribbean Dollar",
+        "XDR"=> "Special Drawing Rights",
+        "XOF"=> "CFA Franc BCEAO",
+        "XPF"=> "CFP Franc",
+        "YER"=> "Yemeni Rial",
+        "ZAR"=> "South African Rand",
+        "ZMK"=> "Zambian Kwacha",
+        "ZWD"=> "Zimbabwean Dollar (1980-2008)",
+        "ZWL"=> "Zimbabwean Dollar"
+      }
+
+    end
+  end
+end

data/lib/currency_exchange/exchangers/open_exchange.rb

@@ -0,0 +1,21 @@
+module CurrencyExchange
+  class Exchangers::OpenExchange
+
+    LATEST_EXCHANGE_URL = "http://openexchangerates.org/latest.json"
+
+    def initialize
+      @transporter = CurrencyExchange::Transporters::ExchangeTransporter.new
+    end
+
+    def convert(number, from, to)
+      number * rates[to.upcase] * ( 1 / rates[from.upcase] ) if rates[to.upcase] && rates[from.upcase]
+    end
+
+    private
+
+    def rates
+      @rates ||= @transporter.retrieve_rates(LATEST_EXCHANGE_URL)['rates']
+    end
+
+  end
+end

data/lib/currency_exchange/ext/fixnum.rb

@@ -0,0 +1,22 @@
+class Numeric
+  UNABLE_TO_EXCHANGE = "Unable to exchange"
+  
+  def exchange(from, to)
+    exchange = CurrencyExchange.convert(self, from, to)
+    exchange ? "$%.2f" % exchange : UNABLE_TO_EXCHANGE
+  end
+  
+  def method_missing(sym, *args, &block)
+    empty, from, to =  currency_string(sym)
+    if CurrencyExchange.has_currency?(from, to)
+      return exchange(from, to)
+    else
+      super.method_missing(sym, *args, &block)
+    end
+  end
+
+  private
+  def currency_string(method)
+    method.to_s.split /(.+)_to_(.+)/
+  end
+end

data/lib/currency_exchange/storage/cache.rb

@@ -0,0 +1,31 @@
+module CurrencyExchange
+  class Storage::Cache
+
+    class << self
+      attr_accessor :cache_strategy
+
+      def instance
+        @instance ||= load_instance
+      end
+    end
+
+    def fetch(key)
+    end
+
+    def store(key, value)
+      value
+    end
+
+    private
+
+    def self.load_instance
+      if self.cache_strategy == :memcache
+        CurrencyExchange::Storage::MemCache.new
+      else
+        self.new
+      end
+    end
+
+  end
+end
+

data/lib/currency_exchange/storage/mem_cache.rb

@@ -0,0 +1,19 @@
+begin 
+  require 'rails'
+rescue LoadError
+  raise "You don't have rails installed"
+end
+
+module CurrencyExchange
+  class Storage::MemCache < Storage::Cache
+
+    def fetch(key)
+      Rails.cache.read(key)
+    end
+      
+    def store(key, value)
+      Rails.cache.write(key, value, :expires_in => 1.day)
+      value
+    end
+  end
+end

data/lib/currency_exchange/transporters/exchange_transporter.rb

@@ -0,0 +1,29 @@
+begin
+  require 'rest-client'
+  require 'json'
+rescue LoadError
+  raise "You don't have the required gems installed"
+end
+
+module CurrencyExchange
+  module Transporters
+    class ExchangeTransporter
+
+      def initialize
+        @storage = CurrencyExchange::Storage::Cache.instance
+      end
+
+      def retrieve_rates(url)
+        @storage.fetch(url) || @storage.store(url, fetch_json(url))
+      end
+
+      private
+
+      def fetch_json(url)
+        response = RestClient.get(url, {:accept => :json})
+        JSON.parse(response.body)
+      end
+
+    end
+  end
+end

data/lib/currency_exchange/version.rb

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

data/lib/currency_exchange.rb

@@ -0,0 +1,36 @@
+require "currency_exchange/version"
+require 'currency_exchange/ext/fixnum'
+
+module CurrencyExchange
+  module Exchangers
+    autoload :OpenExchange, 'currency_exchange/exchangers/open_exchange'
+  end
+
+  module Transporters
+    autoload :ExchangeTransporter, 'currency_exchange/transporters/exchange_transporter'
+  end
+
+  module Data
+    autoload :Currencies, 'currency_exchange/data/currencies'
+  end
+
+  module Storage
+    autoload :Cache, 'currency_exchange/storage/cache'
+    autoload :MemCache, 'currency_exchange/storage/mem_cache'
+  end
+
+  class << self
+    def convert(number, from, to)
+      exchanger.convert(number, from, to) if has_currency?(from, to)
+    end
+
+    def has_currency?(from, to)
+      CurrencyExchange::Data::Currencies.has_currency?(from, to)
+    end
+
+    private
+    def exchanger
+      @exchanger ||= CurrencyExchange::Exchangers::OpenExchange.new
+    end
+  end 
+end

data/spec/data/currencies_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe CurrencyExchange::Data::Currencies do
+
+  describe "#has_currency?" do
+    let(:from) { "USD" }
+    let(:to) { "AUD" }
+    subject { CurrencyExchange::Data::Currencies.has_currency?(from, to) }
+
+    context "when from currency is nil" do
+      let(:from) { nil }
+      it { should == false }
+    end
+
+    context "when to currency is nil" do
+      let(:to) { nil }
+      it { subject.should == false }
+    end
+
+    context "when from currency does not exist in currencies list" do
+      let(:from) { "EEE" }
+      it { subject.should == false }
+    end
+
+    context "when to currency does not exist in currencies list" do
+      let(:to) { "EEE" }
+      it { subject.should == false }
+    end
+
+    it "should return true when from and to currencies exist" do
+      subject.should == true
+    end
+  end
+  
+end

data/spec/exchangers/open_exchange_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe CurrencyExchange::Exchangers::OpenExchange do
+  
+  describe "#convert" do
+    let(:aud) { "AUD" }
+    let(:aud_rate) { 4 }
+    let(:usd) { "USD" }
+    let(:usd_rate) { 2 }
+    let(:rates) { { aud => aud_rate, usd => usd_rate } }
+    let(:number) { 10 }
+    let(:calculated_rate) { number * usd_rate * ( 1 / aud_rate ) }
+    let(:open_exchange) { CurrencyExchange::Exchangers::OpenExchange.new }
+      
+    subject { open_exchange.convert(number, aud, usd) }
+
+    before do
+      open_exchange.stub(:rates).and_return(rates)
+    end
+
+    it "should return exchanged rate" do
+      subject.should == calculated_rate 
+    end
+
+    context "when from/to country code is lowercase" do
+      subject { open_exchange.convert(number, "aud", "usd") }
+
+      it "should return exchanged rate" do
+        subject.should == calculated_rate
+      end
+    end
+
+    context "when country code is not in rates" do
+      subject { open_exchange.convert(number, "ad", "usd") }
+      
+      it { should == nil }
+    end
+  end
+
+  describe "#rates" do
+    let(:url) { CurrencyExchange::Exchangers::OpenExchange::LATEST_EXCHANGE_URL }
+    let(:rates) { { "AED" => 3.1 } }
+    let(:data) { { "disclaimer" => 'abc', "rates" => rates } }
+    let(:transporter) { mock(CurrencyExchange::Transporters::ExchangeTransporter, :retrieve_rates => data) }
+    let(:open_exchange) { CurrencyExchange::Exchangers::OpenExchange.new }
+
+    subject { open_exchange.send(:rates) }
+    
+    before do
+      CurrencyExchange::Transporters::ExchangeTransporter.stub(:new).and_return(transporter)
+    end
+
+    it "should call transporter" do
+      transporter.should_receive(:retrieve_rates).with(url)
+      subject
+    end
+
+    it "should retrieve rates from data" do
+      subject.should == rates
+    end
+
+    context "when data is empty" do
+      let(:data) { {} }
+
+      it { should == nil }
+    end
+
+  end
+
+end

data/spec/ext/fixnum_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Numeric do
+  
+  describe "#exchange" do
+    let(:number) { 10 }
+    let(:converted) { 3 }
+    let(:from) { "USD" }
+    let(:to) { "AUD" }
+
+    subject { number.exchange(from, to) }
+
+    before do
+      CurrencyExchange.stub(:convert).with(number, from, to).and_return(converted)
+    end
+
+    context "when converted value is nil" do
+      let(:converted) { nil }
+      it "should return unable to exchange" do
+        subject.should == Numeric::UNABLE_TO_EXCHANGE
+      end
+    end
+
+    it "should convert exchange value into dollar decimals" do
+      subject.should == "$%.2f" % converted
+    end
+  end
+
+  describe "#currency_to_currency" do
+    let(:aud) { "aud" }
+    let(:usd) { "usd" }
+    let(:number) { 10 }
+
+    subject { number.aud_to_usd }
+
+    it "should call exchange with usd and aud" do
+      CurrencyExchange.should_receive(:convert).with(number, aud, usd)
+      subject
+    end
+
+    context "when currency doesnt exist" do
+      subject { number.au_to_usd }
+      it "should throw no method exception" do
+        expect{subject}.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'currency_exchange' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: currency_exchange
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thil Bandara
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  type: :runtime
+  version_requirements: *id005
+description: A basic library to retrieve and convert currency
+email: 
+- tbandara@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- currency_exchange.gemspec
+- lib/currency_exchange.rb
+- lib/currency_exchange/data/currencies.rb
+- lib/currency_exchange/exchangers/open_exchange.rb
+- lib/currency_exchange/ext/fixnum.rb
+- lib/currency_exchange/storage/cache.rb
+- lib/currency_exchange/storage/mem_cache.rb
+- lib/currency_exchange/transporters/exchange_transporter.rb
+- lib/currency_exchange/version.rb
+- spec/data/currencies_spec.rb
+- spec/exchangers/open_exchange_spec.rb
+- spec/ext/fixnum_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thil/currency_exchange
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: currency_exchange
+rubygems_version: 1.8.9
+signing_key: 
+specification_version: 3
+summary: A basic library to retrieve and convert currency
+test_files: 
+- spec/data/currencies_spec.rb
+- spec/exchangers/open_exchange_spec.rb
+- spec/ext/fixnum_spec.rb
+- spec/spec_helper.rb