money-json-rates 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65ad4a66cac1f91eace625bf55473fbae8356b2f
+  data.tar.gz: a04375b33cfda6acff2cf067f0880c42cdaa0b48
+SHA512:
+  metadata.gz: 98957c324ccc5d62d1a34e578c47af66c371a156dea0e86afa099dcdde3e145c1ac1a6b9d55465620e44712852d00e69755f94589e62bb0f4061b0154a392ecb
+  data.tar.gz: 94af90123b47dbee64d935833c2fc34200d0468d3d20cacd4b16864dd0df91492d313debf5925483a785d1d560cadc32a0b417f5766b100dbd52a4fc8c586990

data/lib/money/bank/json_rates.rb

@@ -0,0 +1,162 @@
+require 'money'
+require 'open-uri'
+
+class Money
+  module Bank
+
+    class JsonRatesRequestError < StandardError ; end
+
+    class NoApiKey < StandardError
+      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
+
+    class JsonRates < Money::Bank::VariableExchange
+
+      SERVICE_HOST = "jsonrates.com"
+      SERVICE_PATH = "/get"
+
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+      attr_accessor :cache, :api_key
+
+      class << self
+        # @return [Integer] Returns the Time To Live (TTL) in seconds.
+        attr_reader :ttl_in_seconds
+
+        # @return [Time] Returns the time when the rates expire.
+        attr_reader :rates_expiration
+
+        ##
+        # Set the Time To Live (TTL) in seconds.
+        #
+        # @param [Integer] the seconds between an expiration and another.
+        def ttl_in_seconds=(value)
+          @ttl_in_seconds = value
+          refresh_rates_expiration! if ttl_in_seconds
+        end
+
+        ##
+        # Set the rates expiration TTL seconds from the current time.
+        #
+        # @return [Time] The next expiration.
+        def refresh_rates_expiration!
+          @rates_expiration = Time.now + ttl_in_seconds
+        end
+      end
+
+      ##
+      # Clears all rates stored in @rates
+      #
+      # @return [Hash] The empty @rates Hash.
+      #
+      # @example
+      #   @bank = JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   @bank.flush_rates           #=> {}
+      def flush_rates
+        @mutex.synchronize{
+          @rates = {}
+        }
+      end
+
+      ##
+      # Clears the specified rate stored in @rates.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from (used
+      #   for key into @rates).
+      # @param [String, Symbol, Currency] to Currency to convert to (used for
+      #   key into @rates).
+      #
+      # @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
+      def flush_rate(from, to)
+        key = rate_key_for(from, to)
+        @mutex.synchronize{
+          @rates.delete(key)
+        }
+      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.
+      #
+      # @example
+      #   @bank = JsonRates.new  #=> <Money::Bank::JsonRates...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      def get_rate(from, to)
+        expire_rates
+
+        @mutex.synchronize{
+          @rates[rate_key_for(from, to)] ||= fetch_rate(from, to)
+        }
+      end
+
+      ##
+      # Flushes all the rates if they are expired.
+      #
+      # @return [Boolean]
+      def expire_rates
+        if self.class.ttl_in_seconds && self.class.rates_expiration <= Time.now
+          flush_rates
+          self.class.refresh_rates_expiration!
+          true
+        else
+          false
+        end
+      end
+
+      private
+
+      ##
+      # Queries for the requested rate and returns it.
+      #
+      # @param [String, Symbol, Currency] from Currency to convert from
+      # @param [String, Symbol, Currency] to Currency to convert to
+      #
+      # @return [BigDecimal] The requested rate.
+      def fetch_rate(from, to)
+        from, to = Currency.wrap(from), Currency.wrap(to)
+        data = build_uri(from, to).read
+        extract_rate(data)
+      end
+
+      ##
+      # Build a URI for the given arguments.
+      #
+      # @param [Currency] from The currency to convert from.
+      # @param [Currency] to The currency to convert to.
+      #
+      # @return [URI::HTTP]
+      def build_uri(from, to)
+        raise NoApiKey if api_key.blank?
+        uri = URI::HTTP.build(
+          :host  => SERVICE_HOST,
+          :path  => SERVICE_PATH,
+          :query => "from=#{from.iso_code}&to=#{to.iso_code}&apiKey=#{api_key}"
+        )
+      end
+
+      ##
+      # Takes the response from jsonrates.com and extract the rate.
+      # @return [BigDecimal]
+      def extract_rate(data)
+        request_hash = JSON.parse(data)
+        raise JsonRatesRequestError, request_hash['error'] if request_hash['error'].present?
+        BigDecimal.new(request_hash['rate'])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: money-json-rates
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrey Skuratovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.5.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: MoneyJsonRates extends Money::Bank::Base and gives access to the current
+  exchange rates using http://jsonrates.com/ api.
+email:
+- skuratowsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/money/bank/json_rates.rb
+homepage: http://github.com/askuratovsky/money-json-rates
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Access the jsonrates.com for gem money
+test_files: []