money-json-rates 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85c0a51f24c0ea3fe650c940046814e18dbab2cd
-  data.tar.gz: 196b94ee24154b084dd58a8c618ba87f76f2ae5d
+  metadata.gz: e55164db6a531154c35743cafd6001a7910d4d76
+  data.tar.gz: e4ea963b5edb18852a91cee6c7dbe0af01188ded
 SHA512:
-  metadata.gz: 730c31992252f3951e9391ac19f253ca03cc62ffb1a805c1d49c693c85e1197b32941aad192390a6d649e6b323c09e401ee46ddb8e231ae1f81610511be6a9c1
-  data.tar.gz: a6eba880d5d24153ff0febedb77ba6cf76695dc2489d4a9decf411c20841d94c202cccc5d6a31e7c3640efc2e7913586515e83e19aab1a6914f97dd10ec12561
+  metadata.gz: 5ed5fa81da1ece9693bd4def1665751c243fa4ff19266751a6e370d5a5e303e6d0ded18fc2bb6b8aa23d1abe43609c03ca3f5b92cdc466998aa6557590fe5a5d
+  data.tar.gz: 79342fdfb5555d07bfb309081756a95e6e5923d4595859e3b32853a9532317c843bd671187a9f992461bb8b9eba39fb9097f459e86f86c74adbb173d4f724b20

data/lib/money/bank/json_rates.rb

@@ -1,24 +1,38 @@
 require 'money'
 require 'open-uri'
 
+
+# Money class, see http://github.com/RubyMoney/money
 class Money
+
+  # Provides classes that aid in the ability of exchange one currency with
+  # another.
   module Bank
 
+    # Exception that will be thrown if jsonrates.com api returns error on api request.
     class JsonRatesRequestError < StandardError ; end
 
+    # Exception that will be thrown if api_key was not specified.
     class NoApiKey < StandardError
+      # Default message.
       def message
         "Blank api_key! You should get your api_key on jsonrates.com and specify it like JsonRates.api_key = YOUR_API_KEY"
       end
     end
 
+    # Money::Bank implementation that gives access to the current exchange rates using jsonrates.com api.
     class JsonRates < Money::Bank::VariableExchange
 
+      # Host of service jsonrates
       SERVICE_HOST = "jsonrates.com"
+
+      # Relative path of jsonrates api
       SERVICE_PATH = "/get"
 
       # @return [Hash] Stores the currently known rates.
       attr_reader :rates
+
+      # accessor of api_key of jsonrates.com service
       attr_accessor :api_key
 
       class << self
@@ -28,11 +42,22 @@ class Money
         # @return [Time] Returns the time when the rates expire.
         attr_reader :rates_expiration
 
+        # @return [Boolean] Returns is Rates Careful mode set.
+        attr_reader :rates_careful
+
+        ##
+        # Set Rates Careful mode
+        #
+        # @param [Boolean] value - mode Careful, if set - don't reload cache if get some exception
+        def rates_careful= value
+          @rates_careful = !!value
+        end
+
         ##
         # Set the Time To Live (TTL) in seconds.
         #
-        # @param [Integer] the seconds between an expiration and another.
-        def ttl_in_seconds=(value)
+        # @param [Integer] value - the seconds between an expiration and another.
+        def ttl_in_seconds= value
           @ttl_in_seconds = value
           refresh_rates_expiration! if ttl_in_seconds
         end
@@ -52,9 +77,9 @@ class Money
       # @return [Hash] The empty @rates Hash.
       #
       # @example
-      #   @bank = JsonRates.new  #=> <Money::Bank::JsonRates...>
-      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
-      #   @bank.flush_rates           #=> {}
+      #   bank = Money::Bank::JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   bank.flush_rates           #=> {}
       def flush_rates
         @mutex.synchronize{
           @rates = {}
@@ -72,9 +97,9 @@ class Money
       # @return [Float] The flushed rate.
       #
       # @example
-      #   @bank = JsonRates.new    #=> <Money::Bank::JsonRates...>
-      #   @bank.get_rate(:USD, :EUR)    #=> 0.776337241
-      #   @bank.flush_rate(:USD, :EUR)  #=> 0.776337241
+      #   bank = Money::Bank::JsonRates.new    #=> <Money::Bank::JsonRates...>
+      #   bank.get_rate(:USD, :EUR)    #=> 0.776337241
+      #   bank.flush_rate(:USD, :EUR)  #=> 0.776337241
       def flush_rate(from, to)
         key = rate_key_for(from, to)
         @mutex.synchronize{
@@ -85,7 +110,7 @@ class Money
       ##
       # Returns the requested rate.
       #
-      # It also flushes all the rates when and if they are expired.
+      # It uses +#get_rate_careful+ or +#get_rate_straight+ respect of @rates_careful value
       #
       # @param [String, Symbol, Currency] from Currency to convert from
       # @param [String, Symbol, Currency] to Currency to convert to
@@ -93,14 +118,73 @@ class Money
       # @return [Float] The requested rate.
       #
       # @example
-      #   @bank = JsonRates.new  #=> <Money::Bank::JsonRates...>
-      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   bank = Money::Bank::JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   bank.get_rate(:USD, :EUR)  #=> 0.776337241
       def get_rate(from, to)
-        expire_rates
+        if self.class.rates_careful
+          get_rate_careful(from, to)
+        else
+          get_rate_straight(from, to)
+        end
+      end
 
-        @mutex.synchronize{
-          @rates[rate_key_for(from, to)] ||= fetch_rate(from, to)
-        }
+      # Registers a conversion rate and returns it (uses +#set_rate+).
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      #
+      # @return [Numeric]
+      #
+      # @example
+      #   bank = Money::Bank::JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   bank.add_rate("USD", "CAD", 1.24515)  #=> 1.24515
+      #   bank.add_rate("CAD", "USD", 0.803115)  #=> 0.803115
+      def add_rate from, to, rate
+        set_rate from, to, rate
+      end
+
+      # Set the rate for the given currencies. Uses +Mutex+ to synchronize data
+      # access.
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      # @param [Hash] opts Options hash to set special parameters
+      # @option opts [Boolean] :without_mutex disables the usage of a mutex
+      #
+      # @return [Numeric]
+      #
+      # @example
+      #   @bank = Money::Bank::JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   bank.set_rate("USD", "CAD", 1.24515)  #=> 1.24515
+      #   bank.set_rate("CAD", "USD", 0.803115)  #=> 0.803115
+      def set_rate from, to, rate
+        if self.class.rates_careful
+          set_rate_with_time(from, to, rate)
+        else
+          super
+        end
+      end
+
+
+      # Return the rate hashkey for the given currencies.
+      #
+      # @param [Currency, String, Symbol] from The currency to exchange from.
+      # @param [Currency, String, Symbol] to The currency to exchange to.
+      #
+      # @return [String]
+      #
+      # @example
+      #   rate_key_for("USD", "CAD") #=> "USD_TO_CAD"
+      #   Money::Bank::JsonRates.rates_careful = true
+      #   rate_key_for("USD", "CAD") #=> "USD_TO_CAD_C"
+      def rate_key_for(from, to)
+        if self.class.rates_careful
+          "#{Currency.wrap(from).iso_code}_TO_#{Currency.wrap(to).iso_code}_C".upcase
+        else
+          super
+        end
       end
 
       ##
@@ -108,7 +192,7 @@ class Money
       #
       # @return [Boolean]
       def expire_rates
-        if self.class.ttl_in_seconds && self.class.rates_expiration <= Time.now
+        if expired?
           flush_rates
           self.class.refresh_rates_expiration!
           true
@@ -119,6 +203,101 @@ class Money
 
       private
 
+      ##
+      # Returns whether the time expired.
+      #
+      # @return [Boolean]
+      def expired?
+        self.class.ttl_in_seconds && self.class.rates_expiration <= Time.now
+      end
+
+      ##
+      # Returns the requested rate.
+      #
+      # It not flushes all the rates and create rates with created_at time.
+      # Check expired for each rate respectively.
+      # If it can't get new rate by some reason it returns cached value.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [Float] The requested rate.
+      def get_rate_careful(from, to)
+
+        rate_key    = rate_key_for(from, to)
+        rate_cached = @rates[rate_key]
+
+        if rate_cached.nil? || expired_time?(rate_cached[:created_at])
+          set_rate_with_time(from, to, fetch_rate(from, to))
+          @rates[rate_key][:rate]
+        else
+          rate_cached[:rate]
+        end
+      rescue JsonRatesRequestError => e
+        if rate_cached.nil?
+          raise e
+        else
+          rate_cached[:rate]
+        end
+      end
+
+      ##
+      # Returns the requested rate.
+      #
+      # It also flushes all the rates when and if they are expired.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [Float] The requested rate.
+      def get_rate_straight(from, to)
+        expire_rates
+
+        @mutex.synchronize{
+          @rates[rate_key_for(from, to)] ||= fetch_rate(from, to)
+        }
+      end
+
+      # Registers a conversion rate with created_at
+      # and returns it (uses +#set_rate_with_time+).
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      #
+      # @return [Numeric]
+      def add_rate_with_time(from, to, rate)
+        set_rate_with_time(from, to, rate)
+      end
+
+      # Set the rate and created_at time for the given currencies.
+      # Uses +Mutex+ to synchronize data access.
+      #
+      # @param [Currency, String, Symbol] from Currency to exchange from.
+      # @param [Currency, String, Symbol] to Currency to exchange to.
+      # @param [Numeric] rate Rate to use when exchanging currencies.
+      # @param [Hash] opts Options hash to set special parameters
+      # @option opts [Boolean] :without_mutex disables the usage of a mutex
+      #
+      # @return [Numeric]
+      def set_rate_with_time(from, to, rate)
+        rate_d = BigDecimal.new(rate.to_s)
+        @mutex.synchronize {
+          @rates[rate_key_for(from, to)] = {rate: rate_d, created_at: Time.now}
+        }
+        rate_d
+      end
+
+      ##
+      # Check if time is expired
+      #
+      # @param [Time] time Time to check
+      #
+      # @return [Boolean] Is the time expired.
+      def expired_time? time
+        time + self.class.ttl_in_seconds.to_i < Time.now
+      end
+
       ##
       # Queries for the requested rate and returns it.
       #
@@ -127,11 +306,23 @@ class Money
       #
       # @return [BigDecimal] The requested rate.
       def fetch_rate(from, to)
-        from, to = Currency.wrap(from), Currency.wrap(to)
-        data = build_uri(from, to).read
+        uri = build_uri(from, to)
+        data = perform_request(uri)
         extract_rate(data)
       end
 
+      ##
+      # Performs request on uri or raise exception message with JsonRatesRequestError
+      #
+      # @param [String] uri Requested uri
+      #
+      # @return [String]
+      def perform_request(uri)
+        uri.read
+      rescue Exception => e
+        raise JsonRatesRequestError, e.message
+      end
+
       ##
       # Build a URI for the given arguments.
       #
@@ -140,7 +331,8 @@ class Money
       #
       # @return [URI::HTTP]
       def build_uri(from, to)
-        raise NoApiKey if api_key.nil? || api_key.blank?
+        from, to = Currency.wrap(from), Currency.wrap(to)
+        raise NoApiKey if api_key.nil? || api_key.empty?
         uri = URI::HTTP.build(
           :host  => SERVICE_HOST,
           :path  => SERVICE_PATH,
@@ -150,10 +342,14 @@ class Money
 
       ##
       # Takes the response from jsonrates.com and extract the rate.
+      #
+      # @param [String] data HTTP-Response of api.
+      #
       # @return [BigDecimal]
       def extract_rate(data)
         request_hash = JSON.parse(data)
-        raise JsonRatesRequestError, request_hash['error'] if request_hash['error'].present?
+        error = request_hash['error']
+        raise JsonRatesRequestError, request_hash['error'] unless (error.nil? || error.empty?)
         BigDecimal.new(request_hash['rate'])
       end
     end

data/spec/json_rates_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe "JsonRates" do
   before :each do
     @bank = Money::Bank::JsonRates.new
+    @bank.api_key = 'xx-xxx'
   end
 
   it "should accept a ttl_in_seconds option" do
@@ -10,6 +11,39 @@ describe "JsonRates" do
     expect(Money::Bank::JsonRates.ttl_in_seconds).to eq(86400)
   end
 
+  describe '.get_rate' do
+    it 'returns rate' do
+      uri = @bank.send(:build_uri, 'USD', 'EUR').to_s
+      stub_request(:get, uri).to_return( :status => 200,
+        :body => '{"utctime":"2015-06-09T18:50:02+02:00","from":"USD","to":"EUR","rate":"0.88770100"}')
+
+      @bank.flush_rates
+      rate = @bank.get_rate('USD', 'EUR')
+      expect(rate).to eq(BigDecimal.new("0.88770100"))
+    end
+    context "in careful mode" do
+
+      it "don't flush rate if get some exception on request" do
+
+        Money::Bank::JsonRates.rates_careful = true
+        Money::Bank::JsonRates.ttl_in_seconds = 0
+
+        @bank.flush_rates
+        @bank.add_rate('USD', 'EUR', 1.011)
+
+
+        uri = @bank.send(:build_uri, 'USD', 'EUR').to_s
+
+        stub_request(:get, uri).to_return(:status => 200, :body => '{"error":"currency XXXX does not exist"}')
+        rate = @bank.get_rate('USD', 'EUR')
+        expect(rate).to eq(BigDecimal.new("1.011"))
+
+        Money::Bank::JsonRates.rates_careful = false
+      end
+
+    end
+  end
+
   describe ".refresh_rates_expiration!" do
     it "set the .rates_expiration using the TTL and the current time" do
       Money::Bank::JsonRates.ttl_in_seconds = 86400
@@ -28,6 +62,14 @@ describe "JsonRates" do
     end
   end
 
+  describe 'careful mode' do
+    it 'returns cached value if exception raised' do
+      @bank.flush_rates
+      @bank.add_rate("USD", "CAD", 32.231)
+      expect(@bank.get_rate("USD", "CAD")).to eq (BigDecimal.new('32.231'))
+    end
+  end
+
   describe ".flush_rate" do
     it "should remove a specific rate from @rates" do
       @bank.add_rate('USD', 'EUR', 1.4)

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 require 'timecop'
 require 'money'
-require 'money/bank/json_rates'
+require 'money/bank/json_rates'
+require 'webmock/rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: money-json-rates
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrey Skuratovsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: JsonRates extends Money::Bank::Base and gives access to the current exchange
-  rates using http://jsonrates.com/ api.
+description: Ruby Money::Bank interface for jsonrates.com exchange data
 email:
 - skuratowsky@gmail.com
 executables: []
@@ -102,3 +115,4 @@ signing_key:
 specification_version: 4
 summary: Access the jsonrates.com for gem money
 test_files: []
+has_rdoc: