spot-rate 0.1.0 → 0.2.0

data/README.md

@@ -18,13 +18,39 @@ Or install it yourself as:
 
 ## Usage
 
+A SpotRate instance will by default use the GoogleCurrencyConverter if no other
+currency converters are registered:
+
 ```ruby
 require 'spot-rate'
 
 puts Time.now
 puts SpotRate.new(:from_currency => 'USD', :to_currency => 'JPY').spot_rate
-#=> 2013-05-01 18:34:09 -0700
-#=> 98.2221786
+# => 2013-05-01 18:34:09 -0700
+# => 98.2221786
+```
+
+If you'd like to register your own currency converter, use the
+`.register_currency_converter` method:
+
+```ruby
+class MyRandomCurrencyConverter
+  def initialize from_currency, to_currency
+    @from_currency = from_currency
+    @to_currency   = to_currency
+  end
+
+  def spot_rate
+    rand # yolo
+  end
+end
+
+SpotRate.register_currency_converter(:random_converter, MyRandomCurrencyConverter)
+spot_rate = SpotRate.new(:from_currency => 'USD', :to_currency => 'JPY')
+puts spot_rate.use(:random_converter).spot_rate
+# => 0.5363022464905228
+puts spot_rate.spot_rate # will go back to using the pre-packaged default Google converter
+# => 98.2221786
 ```
 
 ## Contributing

data/lib/spot_rate/{goog_currency_converter.rb → google_currency_converter.rb}

@@ -1,14 +1,14 @@
 require 'net/http'
 
 class SpotRate
-  class GoogCurrencyConverter
-    GOOG_CURRENCY_URI = 'http://www.google.com/ig/calculator?hl=en&q=1%s=?%s'
+  class GoogleCurrencyConverter
+    GOOGLE_CURRENCY_URI = 'http://www.google.com/ig/calculator?hl=en&q=1%s=?%s'
 
     attr_accessor :from_currency, :to_currency
 
     def initialize from_currency, to_currency
-      self.from_currency = from_currency
-      self.to_currency   = to_currency
+      @from_currency = from_currency
+      @to_currency   = to_currency
     end
 
     def spot_rate
@@ -19,7 +19,7 @@ class SpotRate
   private
 
     def ccy_api_uri
-      URI(GOOG_CURRENCY_URI % [from_currency, to_currency])
+      URI(GOOGLE_CURRENCY_URI % [from_currency, to_currency])
     end
 
     def validate_converter_response!

data/lib/spot_rate/version.rb

@@ -1,3 +1,3 @@
 class SpotRate
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/spot_rate.rb

@@ -3,19 +3,33 @@ class SpotRate
 
   attr_accessor :from_currency, :to_currency
 
+  def self.available_converters
+    @@available_converters ||= {}
+  end
+
+  def self.register_currency_converter converter_key, converter_class
+    self.available_converters[converter_key] = converter_class
+  end
+
   def initialize config = {}
-    self.from_currency = config[:from_currency]
-    self.to_currency   = config[:to_currency]
+    @from_currency = config[:from_currency]
+    @to_currency   = config[:to_currency]
   end
 
-  def spot_rate
-    default_converter.new(self.from_currency, self.to_currency).spot_rate
+  def use requested_converter_key
+    self.class
+        .available_converters[requested_converter_key]
+          .new(@from_currency, @to_currency)
   end
 
-private
+  def spot_rate
+    default_currency_converter.spot_rate
+  end
 
-  def default_converter
-    require './lib/spot_rate/goog_currency_converter'
-    GoogCurrencyConverter
+  def default_currency_converter
+    use(:default)
   end
 end
+
+require './lib/spot_rate/google_currency_converter'
+SpotRate.register_currency_converter :default, SpotRate::GoogleCurrencyConverter

data/spec/spot_rate/google_currency_converter_spec.rb

@@ -0,0 +1,23 @@
+require 'net/http'
+require './lib/spot_rate/google_currency_converter'
+
+describe SpotRate::GoogleCurrencyConverter do
+  describe "#spot_rate" do
+    it "returns a number (no stubbing + requires internet connection)" do
+      converter = described_class.new 'USD', 'JPY'
+      expect(converter.spot_rate.class).to eq Float
+    end
+
+    it "returns the spot conversion rate from the from_currency to the to_currency" do
+      Net::HTTP.stub(:get).and_return('{lhs: "1 U.S. dollar",rhs: "98.222 Japanese yen",error: "",icc: true}')
+      converter = described_class.new 'USD', 'JPY'
+      expect(converter.spot_rate).to eq 98.222
+    end
+
+    it "handles errors when we get an error code back" do
+      Net::HTTP.stub(:get).and_return('{lhs: "does not matter",rhs: "does not matter",error: "4",icc: true}')
+      converter = described_class.new 'USD', 'BAD'
+      expect { converter.spot_rate }.to raise_error SpotRate::CurrencyNotFound
+    end
+  end
+end

data/spec/spot_rate_spec.rb

@@ -1,27 +1,45 @@
-require 'net/http'
 require './lib/spot_rate'
 
-puts Time.now
-puts SpotRate.new(from_currency: 'USD', to_currency: 'JPY').spot_rate
-#describe SpotRate do
-#  describe "#spot_rate" do
-#    it "returns a number (no stubbing + requires internet connection)" do
-#      converter = described_class.new(from_currency: 'USD', to_currency: 'JPY')
-#      expect(converter.spot_rate.class).to eq Float
-#    end
-#
-#    it "returns the spot conversion rate from the from_currency to the to_currency" do
-#      Net::HTTP.stub(:get).and_return('{lhs: "1 U.S. dollar",rhs: "98.222 Japanese yen",error: "",icc: true}')
-#      converter = described_class.new(from_currency: 'USD', to_currency: 'JPY')
-#      expect(converter.spot_rate).to eq 98.222
-#    end
-#
-#    it "handles errors when we get an error code back" do
-#      Net::HTTP.stub(:get).and_return('{lhs: "does not matter",rhs: "does not matter",error: "4",icc: true}')
-#      converter = described_class.new
-#      converter.from_currency = 'USD'
-#      converter.to_currency = 'BAD'
-#      expect { converter.spot_rate }.to raise_error(SpotRate::CurrencyNotFound)
-#    end
-#  end
-#end
+class SomeCurrencyConverter
+  def initialize from, to
+    @from = from
+    @to   = to
+  end
+
+  def spot_rate
+    "#{@from} #{@to}"
+  end
+end
+
+describe SpotRate do
+  describe ".register_currency_converter" do
+    it "adds the converter to the list of available currency converters" do
+      expect(SpotRate.available_converters).to_not include SomeCurrencyConverter
+      SpotRate.register_currency_converter :some_currency_converter, SomeCurrencyConverter
+      expect(SpotRate.available_converters[:some_currency_converter]).to eq SomeCurrencyConverter
+    end
+  end
+
+  describe "#default_currency_converter" do
+    it "is an instance of the Google Currency Converter" do
+      spot_rate = SpotRate.new
+      expect(spot_rate.default_currency_converter).to be_a SpotRate::GoogleCurrencyConverter
+    end
+  end
+
+  describe "#use" do
+    it "returns the spot rate as determined by the requested converter" do
+      SpotRate.register_currency_converter :some_currency_converter, SomeCurrencyConverter
+      spot_rate = SpotRate.new(from_currency: 'something', to_currency: 'another thing')
+      expect(spot_rate.use(:some_currency_converter).spot_rate).to eq "something another thing"
+    end
+  end
+
+  describe "#spot_rate" do
+    it "returns the spot rate as determined by the default converter" do
+      SpotRate.register_currency_converter :default, SomeCurrencyConverter
+      spot_rate = SpotRate.new(from_currency: 'something', to_currency: 'another thing')
+      expect(spot_rate.spot_rate).to eq "something another thing"
+    end
+  end
+end

data/spot_rate.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["jeff.iacono@gmail.com"]
   gem.description   = %q{get current currency spot rates with ruby}
   gem.summary       = %q{current currency spot rates}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/jeffreyiacono/spot-rate"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spot-rate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -88,11 +88,12 @@ files:
 - README.md
 - Rakefile
 - lib/spot_rate.rb
-- lib/spot_rate/goog_currency_converter.rb
+- lib/spot_rate/google_currency_converter.rb
 - lib/spot_rate/version.rb
+- spec/spot_rate/google_currency_converter_spec.rb
 - spec/spot_rate_spec.rb
 - spot_rate.gemspec
-homepage: ''
+homepage: https://github.com/jeffreyiacono/spot-rate
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -112,9 +113,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: current currency spot rates
 test_files:
+- spec/spot_rate/google_currency_converter_spec.rb
 - spec/spot_rate_spec.rb