currencylayer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8609a897bb711b7bfb0771651f86ca1cf76b64f
+  data.tar.gz: 90e220b8604e77ee6b0fb8783eb09be7c61f9261
+SHA512:
+  metadata.gz: ff7762a4543cdcbb5cfa02ad8baa0683061d07eaaaad1c6d29c5db914f155738b39f21f92ad4d3d58084b6a2ae4e9afb52ee00358716581d75f1bfa95f0a8ea0
+  data.tar.gz: 0dc6dbc5b707448222178ee70287989ace921b88360f05d54c3e20fd0039ac772e6cb993aed04093cebb363530e8b36e9c9b97b2587ecd4c90d18c7599de17af

data/lib/money/bank/currencylayer.rb

@@ -0,0 +1,356 @@
+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 RequestError < StandardError ; end
+
+    # Exception that will be thrown if access_key was not specified.
+    class AccessError < StandardError
+      # Default message.
+      def message
+        "Blank access_key! You should get your api access_key on currencylayer.com and specify it"
+      end
+    end
+
+    # Money::Bank implementation that gives access to the current exchange rates using jsonrates.com api.
+    class Currencylayer < Money::Bank::VariableExchange
+
+      # Host of service jsonrates
+      SERVICE_HOST = "apilayer.net"
+
+      # Relative path of jsonrates api
+      SERVICE_PATH = "/api/live"
+
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+      # accessor of access_key of jsonrates.com service
+      attr_accessor :access_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
+
+        # @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] 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
+
+        ##
+        # 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 = Money::Bank::Currencylayer.new  #=> <Money::Bank::Currencylayer...>
+      #   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 = Money::Bank::Currencylayer.new    #=> <Money::Bank::Currencylayer...>
+      #   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 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
+      #
+      # @return [Float] The requested rate.
+      #
+      # @example
+      #   bank = Money::Bank::Currencylayer.new  #=> <Money::Bank::Currencylayer...>
+      #   bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      def get_rate(from, to)
+        if self.class.rates_careful
+          get_rate_careful(from, to)
+        else
+          get_rate_straight(from, to)
+        end
+      end
+
+      # 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::Currencylayer.new  #=> <Money::Bank::Currencylayer...>
+      #   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::Currencylayer.new  #=> <Money::Bank::Currencylayer...>
+      #   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::Currencylayer.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
+
+      ##
+      # Flushes all the rates if they are expired.
+      #
+      # @return [Boolean]
+      def expire_rates
+        if expired?
+          flush_rates
+          self.class.refresh_rates_expiration!
+          true
+        else
+          false
+        end
+      end
+
+      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 RequestError => 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.
+      #
+      # @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)
+        uri = build_uri(from, to)
+        data = perform_request(uri)
+        extract_rate(data, from, to)
+      end
+
+      ##
+      # Performs request on uri or raise exception message with RequestError
+      #
+      # @param [String] uri Requested uri
+      #
+      # @return [String]
+      def perform_request(uri)
+        uri.read
+      rescue Exception => e
+        raise RequestError, e.message
+      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 AccessError if access_key.nil? || access_key.empty?
+        uri = URI::HTTP.build(
+          :host  => SERVICE_HOST,
+          :path  => SERVICE_PATH,
+          :query => "access_key=#{access_key}&source=#{from}&currencies=#{to}"
+        )
+      end
+
+      ##
+      # Takes the response from jsonrates.com and extract the rate.
+      #
+      # @param [String] data HTTP-Response of api.
+      #
+      # @return [BigDecimal]
+      def extract_rate(data, from, to)
+        request_hash = JSON.parse(data)
+        success = request_hash['success']
+        raise RequestError, request_hash['error']['info'] unless success
+        BigDecimal.new(request_hash['quotes']["#{from}#{to}"].to_s)
+      end
+    end
+  end
+end

data/spec/currencylayer_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe "Currencylayer" do
+  before :each do
+    @bank = Money::Bank::Currencylayer.new
+    @bank.access_key = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+  end
+
+  it "should accept a ttl_in_seconds option" do
+    Money::Bank::Currencylayer.ttl_in_seconds = 86400
+    expect(Money::Bank::Currencylayer.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 => '{"success":true,"terms":"https:\/\/currencylayer.com\/terms","privacy":"https:\/\/currencylayer.com\/privacy","timestamp":1434443053,"source":"USD","quotes":{"USDEUR":0.887701}}')
+
+      @bank.flush_rates
+      rate = @bank.get_rate('USD', 'EUR')
+      expect(rate).to eq(BigDecimal.new("0.887701"))
+    end
+    context "in careful mode" do
+
+      it "don't flush rate if get some exception on request" do
+
+        Money::Bank::Currencylayer.rates_careful = true
+        Money::Bank::Currencylayer.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 => '{"success":false,"error":{"code":202,"info":"You have provided one or more invalid Currency Codes. [Required format: currencies=EUR,USD,GBP,...]"}}')
+        rate = @bank.get_rate('USD', 'EUR')
+        expect(rate).to eq(BigDecimal.new("1.011"))
+
+        Money::Bank::Currencylayer.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::Currencylayer.ttl_in_seconds = 86400
+      new_time = Time.now
+      Timecop.freeze(new_time)
+      Money::Bank::Currencylayer.refresh_rates_expiration!
+      expect(Money::Bank::Currencylayer.rates_expiration).to eq(new_time + 86400)
+    end
+  end
+
+  describe ".flush_rates" do
+    it "should empty @rates" do
+      @bank.add_rate("USD", "CAD", 1.24515)
+      @bank.flush_rates
+      expect(@bank.rates).to eq({})
+    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.flush_rates
+      @bank.add_rate('USD', 'EUR', 1.4)
+      @bank.add_rate('USD', 'JPY', 0.3)
+      @bank.flush_rate('USD', 'EUR')
+      expect(@bank.rates).to include('USD_TO_JPY')
+      expect(@bank.rates).to_not include('USD_TO_EUR')
+    end
+  end
+
+  describe ".expire_rates" do
+    before do
+      Money::Bank::Currencylayer.ttl_in_seconds = 1000
+    end
+
+    context "when the ttl has expired" do
+      before do
+        new_time = Time.now + 1001
+        Timecop.freeze(new_time)
+      end
+
+      it "should flush all rates" do
+        expect(@bank).to receive(:flush_rates)
+        @bank.expire_rates
+      end
+
+      it "updates the next expiration time" do
+        exp_time = Time.now + 1000
+
+        @bank.expire_rates
+        expect(Money::Bank::Currencylayer.rates_expiration).to eq(exp_time)
+      end
+    end
+
+    context "when the ttl has not expired" do
+      it "not should flush all rates" do
+        expect(@bank).to_not receive(:flush_rates)
+        @bank.expire_rates
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'timecop'
+require 'money'
+require 'money/bank/currencylayer'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: currencylayer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrey Skuratovsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-16 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
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: This gem extends Money::Bank::VariableExchange with Money::Bank::Currencylayer
+  and gives you access to the current exchange rates on currencylayer.com.
+email:
+- skuratowsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/money/bank/currencylayer.rb
+- spec/currencylayer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/askuratovsky/currencylayer
+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 to the currencylayer.com online exchange rates
+test_files: []
+has_rdoc: