money-open-exchange-rates 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78e5f382a89d63ca2810fc5fe93b373bdfe0dd2b
-  data.tar.gz: c8262bcd25e9a5295c37db99fe197d9ae23a1e55
+  metadata.gz: b5a908e851c07a69ab0aca84da9edb9c1f596112
+  data.tar.gz: d63b70c7f7bd0300e44bdee7b723c558e862ef62
 SHA512:
-  metadata.gz: ec7b0fca5d35cc3427a434e97ec5a8f7d2c3a2f52bbbc37df7178e4b99c7d7b386a429489ebbd18a1b9142ed31d2fd9492b7f2557330cdc3b4bce77bff36ce7c
-  data.tar.gz: 7eb57b17c948ecdc2e83b951dfb2c6ce0fae81e242c32129788ead04fa1eb3fe75120c38c44d3f49393c52e2bcca85f4478108be3966ee9910a85df495c9cf68
+  metadata.gz: d4dfe2d85a96e772b193cfc8bd2986c2caf8e02e56fa1eb46ce86e9993d47b80d00a26eb243a1d6a3b51de56d8259a8de674217e99e89731e94a8665415c9c95
+  data.tar.gz: bd056b885c383fa246593a57685c61a2f33001ad1a120f5415d9d982272a03942af9bb9599976078912a424cf2626e0cb687fc8cce2064a728e175bad4b2ea99

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/README.markdown

@@ -16,6 +16,10 @@ moe.update_rates
 # set the seconds after than the current rates are automatically expired
 # by default, they never expire
 moe.ttl_in_seconds = 86400
+# (optional)
+# use https to fetch rates from Open Exchange Rates
+# disabled by default to support free-tier users
+moe.secure_connection = true
 # Store in cache
 moe.save_rates
 
@@ -63,6 +67,7 @@ Dmitry Dedov (2)
 chatgris (2)
 Sam Lown (1)
 Fabio Cantoni (1)
+shpupti (1)
 
 ## License
 

data/lib/money/bank/open_exchange_rates_bank.rb

@@ -5,15 +5,16 @@ require 'json'
 
 class Money
   module Bank
-    class InvalidCache < StandardError ; end
+    class InvalidCache < StandardError; end
 
-    class NoAppId < StandardError ; end
+    class NoAppId < StandardError; end
 
+    # OpenExchangeRatesBank base class
     class OpenExchangeRatesBank < Money::Bank::VariableExchange
-
       OER_URL = 'http://openexchangerates.org/latest.json'
+      SECURE_OER_URL = OER_URL.tr('http:', 'https:')
 
-      attr_accessor :cache, :app_id
+      attr_accessor :cache, :app_id, :secure_connection
       attr_reader :doc, :oer_rates, :rates_expiration, :ttl_in_seconds
 
       def ttl_in_seconds=(value)
@@ -27,16 +28,14 @@ class Money
           currency = exchange_rate.first
           next unless Money::Currency.find(currency)
           set_rate('USD', currency, rate)
-          set_rate(currency, 'USD', 1.0/rate)
+          set_rate(currency, 'USD', 1.0 / rate)
         end
       end
 
       def save_rates
-        raise InvalidCache unless cache
+        fail InvalidCache unless cache
         text = read_from_url
-        if has_valid_rates?(text)
-          store_in_cache(text)
-        end
+        store_in_cache(text) if valid_rates?(text)
       rescue Errno::ENOENT
         raise InvalidCache
       end
@@ -47,10 +46,17 @@ class Money
       end
 
       def expire_rates
-        if ttl_in_seconds && rates_expiration <= Time.now
-          update_rates
-          refresh_rates_expiration
-        end
+        return unless ttl_in_seconds
+        return if rates_expiration > Time.now
+        update_rates
+        refresh_rates_expiration
+      end
+
+      def source_url
+        fail NoAppId if app_id.nil? || app_id.empty?
+        oer_url = OER_URL
+        oer_url = SECURE_OER_URL if secure_connection
+        "#{oer_url}?app_id=#{app_id}"
       end
 
       protected
@@ -75,18 +81,13 @@ class Money
         end
       end
 
-      def source_url
-        raise NoAppId if app_id.nil? || app_id.empty?
-        "#{OER_URL}?app_id=#{app_id}"
-      end
-
       def read_from_url
         open(source_url).read
       end
 
-      def has_valid_rates?(text)
+      def valid_rates?(text)
         parsed = JSON.parse(text)
-        parsed && parsed.has_key?('rates')
+        parsed && parsed.key?('rates')
       rescue JSON::ParserError
         false
       end

data/test/open_exchange_rates_bank_test.rb

@@ -4,123 +4,125 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
 
 describe Money::Bank::OpenExchangeRatesBank do
   subject { Money::Bank::OpenExchangeRatesBank.new }
-
-  before do
-    @cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'latest.json'))
+  let(:url) { Money::Bank::OpenExchangeRatesBank::OER_URL }
+  let(:secure_url) { Money::Bank::OpenExchangeRatesBank::SECURE_OER_URL }
+  let(:temp_cache_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
+  end
+  let(:cache_path) do
+    File.expand_path(File.join(File.dirname(__FILE__), 'latest.json'))
   end
 
   describe 'exchange' do
     before do
       subject.app_id = TEST_APP_ID
-      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
-      subject.cache = @temp_cache_path
-      stub(subject).read_from_url { File.read @cache_path }
+      subject.cache = temp_cache_path
+      stub(subject).read_from_url { File.read cache_path }
       subject.save_rates
     end
 
     after do
-      File.unlink(@temp_cache_path)
+      File.unlink(temp_cache_path)
     end
 
-    describe "without rates" do
-      it "should be able to exchange a money to its own currency even without rates" do
-        money = Money.new(0, "USD")
-        subject.exchange_with(money, "USD").must_equal money
+    describe 'without rates' do
+      it 'able to exchange a money to its own currency even without rates' do
+        money = Money.new(0, 'USD')
+        subject.exchange_with(money, 'USD').must_equal money
       end
 
-      it "should raise if it can't find an exchange rate" do
-        money = Money.new(0, "USD")
-        proc { subject.exchange_with(money, "SSP") }.must_raise Money::Bank::UnknownRate
+      it "raise if it can't find an exchange rate" do
+        money = Money.new(0, 'USD')
+        proc { subject.exchange_with(money, 'SSP') }
+          .must_raise Money::Bank::UnknownRate
       end
     end
 
-    describe "with rates" do
-      before do 
+    describe 'with rates' do
+      before do
         subject.update_rates
       end
 
-      it "should be able to exchange money from USD to a known exchange rate" do
-        money = Money.new(100, "USD")
-        subject.exchange_with(money, "BBD").must_equal Money.new(200, 'BBD')
+      it 'should be able to exchange money from USD to a known exchange rate' do
+        money = Money.new(100, 'USD')
+        subject.exchange_with(money, 'BBD').must_equal Money.new(200, 'BBD')
       end
 
-      it "should be able to exchange money from a known exchange rate to USD" do
-        money = Money.new(200, "BBD")
-        subject.exchange_with(money, "USD").must_equal Money.new(100, 'USD')
+      it 'should be able to exchange money from a known exchange rate to USD' do
+        money = Money.new(200, 'BBD')
+        subject.exchange_with(money, 'USD').must_equal Money.new(100, 'USD')
       end
 
       it "should raise if it can't find an exchange rate" do
-        money = Money.new(0, "USD")
-        proc { subject.exchange_with(money, "SSP") }.must_raise Money::Bank::UnknownRate
+        money = Money.new(0, 'USD')
+        proc { subject.exchange_with(money, 'SSP') }
+          .must_raise Money::Bank::UnknownRate
       end
     end
-
   end
 
   describe 'update_rates' do
     before do
       subject.app_id = TEST_APP_ID
-      subject.cache = @cache_path
+      subject.cache = cache_path
       subject.update_rates
     end
 
-    it "should update itself with exchange rates from OpenExchangeRates" do
+    it 'should update itself with exchange rates from OpenExchangeRates' do
       subject.oer_rates.keys.each do |currency|
         next unless Money::Currency.find(currency)
-        subject.get_rate("USD", currency).must_be :>, 0
+        subject.get_rate('USD', currency).must_be :>, 0
       end
     end
 
-    it "should not return 0 with integer rate" do
+    it 'should not return 0 with integer rate' do
       wtf = {
-        :priority => 1,
-        :iso_code => "WTF",
-        :name => "WTF",
-        :symbol => "WTF",
-        :subunit => "Cent",
-        :subunit_to_unit => 1000,
-        :separator => ".",
-        :delimiter => ","
+        priority: 1,
+        iso_code: 'WTF',
+        name: 'WTF',
+        symbol: 'WTF',
+        subunit: 'Cent',
+        subunit_to_unit: 1000,
+        separator: '.',
+        delimiter: ','
       }
       Money::Currency.register(wtf)
-      subject.add_rate("USD", "WTF", 2)
-      subject.add_rate("WTF", "USD", 2)
+      subject.add_rate('USD', 'WTF', 2)
+      subject.add_rate('WTF', 'USD', 2)
       subject.exchange_with(5000.to_money('WTF'), 'USD').cents.wont_equal 0
     end
 
     # in response to #4
-    it "should exchange btc" do
+    it 'should exchange btc' do
       btc = {
-        :priority => 1,
-        :iso_code => "BTC",
-        :name => "Bitcoin",
-        :symbol => "BTC",
-        :subunit => "Cent",
-        :subunit_to_unit => 1000,
-        :separator => ".",
-        :delimiter => ","
+        priority: 1,
+        iso_code: 'BTC',
+        name: 'Bitcoin',
+        symbol: 'BTC',
+        subunit: 'Cent',
+        subunit_to_unit: 1000,
+        separator: '.',
+        delimiter: ','
       }
       Money::Currency.register(btc)
       rate = 13.7603
-      subject.add_rate("USD", "BTC", 1 / 13.7603)
-      subject.add_rate("BTC", "USD", rate)
-      subject.exchange_with(100.to_money("BTC"), 'USD').cents.must_equal 137603
+      subject.add_rate('USD', 'BTC', 1 / 13.7603)
+      subject.add_rate('BTC', 'USD', rate)
+      subject.exchange_with(100.to_money('BTC'), 'USD').cents.must_equal 137_603
     end
   end
 
   describe 'App ID' do
-
     before do
-      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
-      subject.cache = @temp_cache_path
-      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+      subject.cache = temp_cache_path
+      stub(OpenURI::OpenRead).open(url) { File.read cache_path }
     end
 
     it 'should raise an error if no App ID is set' do
       proc { subject.save_rates }.must_raise Money::Bank::NoAppId
     end
 
-    #TODO: As App IDs are compulsory soon, need to add more tests handle
+    # TODO: As App IDs are compulsory soon, need to add more tests handle
     # app_id-specific errors from
     # https://openexchangerates.org/documentation#errors
   end
@@ -132,7 +134,7 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
 
     it 'should get from url' do
-      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+      stub(OpenURI::OpenRead).open(url) { File.read cache_path }
       subject.update_rates
       subject.oer_rates.wont_be_empty
     end
@@ -142,14 +144,34 @@ describe Money::Bank::OpenExchangeRatesBank do
     end
   end
 
+  describe 'secure_connection' do
+    it "should use the non-secure http url if secure_connection isn't set" do
+      subject.secure_connection = nil
+      subject.app_id = TEST_APP_ID
+      subject.source_url.must_equal "#{url}?app_id=#{TEST_APP_ID}"
+    end
+
+    it 'should use the non-secure http url if secure_connection is false' do
+      subject.secure_connection = false
+      subject.app_id = TEST_APP_ID
+      subject.source_url.must_equal "#{url}?app_id=#{TEST_APP_ID}"
+    end
+
+    it 'should use the secure https url if secure_connection is set to true' do
+      subject.secure_connection = true
+      subject.app_id = TEST_APP_ID
+      subject.source_url.must_equal "#{secure_url}?app_id=#{TEST_APP_ID}"
+    end
+  end
+
   describe 'no valid file for cache' do
     before do
-      subject.cache = "space_dir#{rand(999999999)}/out_space_file.json"
+      subject.cache = "space_dir#{rand(999_999_999)}/out_space_file.json"
       subject.app_id = TEST_APP_ID
     end
 
     it 'should get from url' do
-      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+      stub(OpenURI::OpenRead).open(url) { File.read cache_path }
       subject.update_rates
       subject.oer_rates.wont_be_empty
     end
@@ -161,40 +183,38 @@ describe Money::Bank::OpenExchangeRatesBank do
 
   describe 'using proc for cache' do
     before :each do
-      $global_rates = nil
-      subject.cache = Proc.new {|v|
+      @global_rates = nil
+      subject.cache = proc {|v|
         if v
-          $global_rates = v
+          @global_rates = v
         else
-          $global_rates
+          @global_rates
         end
       }
       subject.app_id = TEST_APP_ID
     end
 
     it 'should get from url normally' do
-      stub(subject).source_url() { @cache_path }
+      stub(subject).source_url { cache_path }
       subject.update_rates
       subject.oer_rates.wont_be_empty
     end
 
     it 'should save from url and get from cache' do
-      stub(subject).source_url { @cache_path }
+      stub(subject).source_url { cache_path }
       subject.save_rates
-      $global_rates.wont_be_empty
+      @global_rates.wont_be_empty
       dont_allow(subject).source_url
       subject.update_rates
       subject.oer_rates.wont_be_empty
     end
-
   end
 
   describe 'save rates' do
     before do
       subject.app_id = TEST_APP_ID
-      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
-      subject.cache = @temp_cache_path
-      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+      subject.cache = temp_cache_path
+      stub(OpenURI::OpenRead).open(url) { File.read cache_path }
       subject.save_rates
     end
 
@@ -202,33 +222,33 @@ describe Money::Bank::OpenExchangeRatesBank do
       begin
         subject.update_rates
       rescue
-        assert false, "Should allow updating after saving"
+        assert false, 'Should allow updating after saving'
       end
     end
 
-    it "should not break an existing file if save fails to read" do
-      initial_size = File.read(@temp_cache_path).size
-      stub(subject).read_from_url {""}
+    it 'should not break an existing file if save fails to read' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).read_from_url { '' }
       subject.save_rates
-      File.open(@temp_cache_path).read.size.must_equal initial_size
+      File.open(temp_cache_path).read.size.must_equal initial_size
     end
 
-    it "should not break an existing file if save returns json without rates" do
-      initial_size = File.read(@temp_cache_path).size
-      stub(subject).read_from_url { %Q({"error": "An error"}) }
+    it 'should not break an existing file if save returns json without rates' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).read_from_url { '{"error": "An error"}' }
       subject.save_rates
-      File.open(@temp_cache_path).read.size.must_equal initial_size
+      File.open(temp_cache_path).read.size.must_equal initial_size
     end
 
-    it "should not break an existing file if save returns a invalid json" do
-      initial_size = File.read(@temp_cache_path).size
-      stub(subject).read_from_url { %Q({invalid_json: "An error"}) }
+    it 'should not break an existing file if save returns a invalid json' do
+      initial_size = File.read(temp_cache_path).size
+      stub(subject).read_from_url { '{invalid_json: "An error"}' }
       subject.save_rates
-      File.open(@temp_cache_path).read.size.must_equal initial_size
+      File.open(temp_cache_path).read.size.must_equal initial_size
     end
 
     after do
-      File.delete @temp_cache_path
+      File.delete temp_cache_path
     end
   end
 
@@ -238,9 +258,10 @@ describe Money::Bank::OpenExchangeRatesBank do
       subject.ttl_in_seconds = 1000
       @usd_eur_rate = 0.655
       subject.add_rate('USD', 'EUR', @usd_eur_rate)
-      @temp_cache_path = File.expand_path(File.join(File.dirname(__FILE__), 'tmp.json'))
-      subject.cache = @temp_cache_path
-      stub(OpenURI::OpenRead).open(Money::Bank::OpenExchangeRatesBank::OER_URL) { File.read @cache_path }
+      subject.cache = temp_cache_path
+      stub(OpenURI::OpenRead).open(url) do
+        File.read cache_path
+      end
     end
 
     describe 'when the ttl has expired' do

data/test/test_helper.rb

@@ -10,5 +10,6 @@ TEST_APP_ID_PATH = File.join(File.dirname(__FILE__), '..', 'TEST_APP_ID')
 TEST_APP_ID = ENV['TEST_APP_ID'] || File.read(TEST_APP_ID_PATH)
 
 if TEST_APP_ID.nil? || TEST_APP_ID.empty?
-  raise "Please add a valid app id to file #{TEST_APP_ID_PATH} or to TEST_APP_ID environment"
+  fail "Please add a valid app id to file #{TEST_APP_ID_PATH} or to " \
+    ' TEST_APP_ID environment'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-open-exchange-rates
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Laurent Arnoud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2015-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem that calculates the exchange rate using published rates from open-exchange-rates.
   Compatible with the money gem.
 email: laurent@spkdev.net
@@ -149,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="