fixer_currency 3.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a49f8eaca5bb9152f750e6336416b0991c3358ee4a7653555820e531551b71cd
+  data.tar.gz: 9c813b15ff729dd8f801d4cb917122a3cb31b857fcfae011133883226f123f7d
+SHA512:
+  metadata.gz: 3a6c7877a40ceb7076f4463f30bb2fbbb6d1a403a1f9ce60744448e2f5a7ae3f9620ce367146870840bdbcf827b738ba91315c35caf45953eacf59560fff9240
+  data.tar.gz: afe799a1adda9a9c6a438e7abe67c06159ae2389548793b30b732d62de7205f68c9ba34be1d13438090c3de77f73bfffb697ca84f4606cec684986538902a697

data/AUTHORS

@@ -0,0 +1,11 @@
+andersonbrandon
+cover
+Donald Ball
+Daniel Doubrovkine
+James Chen
+Jérémy Lecour
+Lars Pind
+Shane Emmons
+sowenjub
+yinquanteo
+Tarang Patel

data/CHANGELOG.md

@@ -0,0 +1,133 @@
+3.4.1
+=====
+
+- Fix the deprecated URL
+
+3.4.0
+=====
+
+- Add captcha response detection
+- Use finance.google.com for reliability across different regions
+
+3.3.0
+=====
+
+- Update Money gem dep
+
+3.2.1
+=====
+- Increase precision of rates by using inverse reciprocals for certain currencyes
+
+3.0.0
+=====
+
+- Google closed ig/calculator, so we're now using finance/calculator
+- fix incorrect parsing of complex rates
+
+Google Currency 2.2.0
+=====================
+
+- Update money dependency to ~> 5.1.0
+
+Google Currency 2.1.0
+=====================
+
+- Update money dependency to ~> 5.0.0
+
+Google Currency 2.0.2
+=====================
+
+Bugfixes
+--------
+ - Fix encoding issue
+
+Google Currency 2.0.1
+=====================
+
+Features
+--------
+ - Handles funky exchange rates (Arnaud Joubay)
+
+Bugfixes
+--------
+ - Fix for running under 1.9.2 in TextMate (larspind)
+
+Google Currency 2.0.0
+=====================
+
+Features
+--------
+ - Added multi_json to allow users to select their own JSON parsing engine.
+ - Removed deprecated method #get_google_rate.
+
+Bugfixes
+--------
+ - Updated deprecated rake tasks
+
+Google Currency 1.1.1
+=====================
+
+Bugfixes
+--------
+ - Built gem using Ruby 1.8.7 to bypass a known error with RubyGems 1.5.0 and
+   Ruby 1.9.2
+
+Google Currency 1.1.0
+=====================
+
+Features
+--------
+ - Deprecated #get_google_rate, use #get_rate (thanks RMU Alumni)
+
+Bugfixes
+---------
+ - Fixed an issue when rates over 1000 did not parse correctly (thanks Brandon
+   Anderson)
+
+Google Currency 1.0.3
+=====================
+
+Features
+--------
+ - Update `money` requirement to `~> 3.5`
+
+Google Currency 1.0.2
+=====================
+
+Features
+--------
+ - Replace `eval` with `JSON.parse`
+ - Use BigDecimal instead of Float
+
+Bugfixes
+--------
+ - Quell parenthetical warnings in specs
+
+Google Currency 1.0.1
+=====================
+
+Features
+--------
+ - Update `money` requirement to `~> 3.1.5`
+
+Google Currency 1.0.0
+=====================
+
+Features
+--------
+ - Updated `money` requirement to `~> 3.1.0`
+
+Google Currency 0.1.1
+=====================
+
+Features
+--------
+ - Added #flush_rates
+ - Added #flush_rate
+
+Google Currency 0.1.0
+=====================
+
+Features
+--------
+ - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Shane Emmons
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+Fixer Currency
+===============
+This gem extends Money::Bank::VariableExchange with Money::Bank::FixerCurrency
+and gives you access to the current fixer.io exchange rates.
+
+This gem was forked from the [Money::Bank::GoogleCurrency](http://rubymoney.github.com/google_currency)
+gem.
+
+Usage
+-----
+
+```ruby
+
+require 'money'
+require 'money/bank/fixer_currency'
+
+# (optional)
+# set the seconds after than the current rates are automatically expired
+# by default, they never expire
+Money::Bank::FixerCurrency.ttl_in_seconds = 86400
+
+# set default bank to instance of FixerCurrency with access key parameter
+# being your access_key from fixer.io
+Money.default_bank = Money::Bank::FixerCurrency.new('your_access_key')
+
+# create a new money object, and use the standard #exchange_to method
+money = Money.new(1_00, "USD") # amount is in cents
+money.exchange_to(:EUR)
+
+# or install and use the 'monetize' gem
+require 'monetize'
+money = 1.to_money(:USD)
+money.exchange_to(:EUR)
+
+```
+
+An `UnknownRate` will be thrown if `#exchange_to` is called with a `Currency`
+that `Money` knows, but fixer.io does not.
+
+An `UnknownCurrency` will be thrown if `#exchange_to` is called with a
+`Currency` that `Money` does not know.
+
+A `FixerCurrencyFetchError` will be thrown if there is an unknown issue with
+parsing the response including rates from fixer.io's API.
+
+Caveats
+-------
+
+This gem uses [fixer.io](https://fixer.io/) under the hood.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake/clean'
+
+CLOBBER.include('.yardoc', 'doc')
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path("../fixer_currency.gemspec", __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError
+  task(:spec){abort "`gem install rspec` to run specs"}
+end
+task :default => :spec
+task :test => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options << "--files" << "CHANGELOG.md,LICENSE"
+  end
+rescue LoadError
+  task(:yard){abort "`gem install yard` to generate documentation"}
+end
+
+begin
+  require 'rubygems/package_task'
+  Gem::PackageTask.new(gemspec) do |pkg|
+    pkg.gem_spec = gemspec
+  end
+  task :gem => :gemspec
+rescue LoadError
+  task(:gem){abort "`gem install rake` to package gems"}
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh "gem install pkg/#{gemspec.full_name}.gem"
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/fixer_currency.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name        = 'fixer_currency'
+  s.version     = '3.4.2'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Emily Wilson']
+  s.email       = ['emilywilson@privy.com']
+  s.homepage    = 'https://github.com/Privy/fixer_currency'
+  s.summary     = 'Access the fixer.io exchange rate data.'
+  s.description = 'FixerCurrency extends Money::Bank::Base and gives you access
+   to the current fixer.io exchange rates.'
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'ffi'
+  s.add_development_dependency 'rspec', '>= 3.0.0'
+  s.add_development_dependency 'yard', '>= 0.5.8'
+
+  s.add_dependency 'money', '~> 6.7'
+
+  s.files =  Dir.glob('{lib,spec}/**/*')
+  s.files += %w(LICENSE README.md CHANGELOG.md AUTHORS)
+  s.files += %w(Rakefile .gemtest fixer_currency.gemspec)
+
+  s.require_path = 'lib'
+end

data/lib/money/bank/fixer_currency.rb

@@ -0,0 +1,162 @@
+require 'money'
+require 'money/rates_store/rate_removal_support'
+require 'open-uri'
+
+class Money
+  module Bank
+    # # Raised when there is an unexpected error in extracting exchange rates
+    # # from fixer.io
+    class FixerCurrencyFetchError < Error
+    end
+
+    # VariableExchange bank that handles fetching exchange rates from fixer.io
+    # and storing them in the in memory rates store.
+    class FixerCurrency < Money::Bank::VariableExchange
+      SERVICE_HOST = 'data.fixer.io'.freeze
+      SERVICE_PATH = '/api/latest'.freeze
+
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+      # @return [String] Access key from fixer.io allowing access to API
+      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
+
+        ##
+        # 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
+
+      def initialize(access_key)
+        super()
+        @store.extend Money::RatesStore::RateRemovalSupport
+        @access_key = access_key
+      end
+
+      ##
+      # Clears all rates stored in @rates
+      #
+      # @return [Hash] The empty @rates Hash.
+      #
+      # @example
+      #   @bank = FixerCurrency.new  #=> <Money::Bank::FixerCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      #   @bank.flush_rates           #=> {}
+      def flush_rates
+        store.clear_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 = FixerCurrency.new    #=> <Money::Bank::FixerCurrency...>
+      #   @bank.get_rate(:USD, :EUR)    #=> 0.776337241
+      #   @bank.flush_rate(:USD, :EUR)  #=> 0.776337241
+      def flush_rate(from, to)
+        store.remove_rate(from, to)
+      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 = FixerCurrency.new  #=> <Money::Bank::FixerCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      def get_rate(from, to)
+        expire_rates
+
+        fetch_rates if !store.get_rate(from, :EUR) || !store.get_rate(to, :EUR)
+
+        begin
+          return store.get_rate(from, :EUR) / store.get_rate(to, :EUR)
+        rescue
+          raise UnknownRate
+        end
+      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
+
+      ##
+      # Makes an api call to populate all of the exchange rates in the in
+      # memory store.
+      def fetch_rates
+        data = build_uri.read
+        extract_rates(data)
+      end
+
+      ##
+      # Build a URI for the given arguments.
+      #
+      # @return [URI::HTTP]
+      def build_uri
+        URI::HTTP.build(
+          host: SERVICE_HOST,
+          path: SERVICE_PATH,
+          query: "access_key=#{access_key}"
+        )
+      end
+
+      ##
+      # Takes the response from fixer.io and extract the rates and adds them to
+      # the rates store.
+      #
+      # @param [String] data The hash of rates from fixer to decode.
+      def extract_rates(data)
+        rates = JSON.parse(data)['rates']
+        rates.each do |currency, rate|
+          store.add_rate(currency, :EUR, 1 / BigDecimal(rate.to_s))
+        end
+      rescue
+        raise FixerCurrencyFetchError
+      end
+    end
+  end
+end

data/lib/money/rates_store/rate_removal_support.rb

@@ -0,0 +1,27 @@
+module Money::RatesStore
+  module RateRemovalSupport
+    # Remove a conversion rate and returns it. Uses +Mutex+ to synchronize data access.
+    #
+    # @param [String] currency_iso_from Currency to exchange from.
+    # @param [String] currency_iso_to Currency to exchange to.
+    #
+    # @return [Numeric]
+    #
+    # @example
+    #   store = Money::RatesStore::Memory.new
+    #   store.remove_rate("USD", "CAD")
+    #   store.remove_rate("CAD", "USD")
+    def remove_rate(currency_iso_from, currency_iso_to)
+      transaction { index.delete rate_key_for(currency_iso_from, currency_iso_to) }
+    end
+
+    # Clears all conversion rates. Uses +Mutex+ to synchronize data access.
+    #
+    # @example
+    #   store = Money::RatesStore::Memory.new
+    #   store.clear_rates
+    def clear_rates
+      transaction { @index = {} }
+    end
+  end
+end

data/spec/fixer_currency_with_json_spec.rb

@@ -0,0 +1,142 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'money'
+require 'money/bank/fixer_currency'
+
+describe Money::Bank::FixerCurrency do
+  before :each do
+    @bank = Money::Bank::FixerCurrency.new('123')
+  end
+
+  context 'given ttl_in_seconds' do
+    before(:each) do
+      Money::Bank::FixerCurrency.ttl_in_seconds = 86_400
+    end
+
+    it 'should accept a ttl_in_seconds option' do
+      expect(Money::Bank::FixerCurrency.ttl_in_seconds).to eq(86_400)
+    end
+
+    describe '.refresh_rates_expiration!' do
+      it 'set the #rates_expiration using the TTL and the current time' do
+        new_time = Time.now
+        Timecop.freeze(new_time)
+        Money::Bank::FixerCurrency.refresh_rates_expiration!
+        expect(Money::Bank::FixerCurrency.rates_expiration)
+          .to eq(new_time + 86_400)
+      end
+    end
+  end
+
+  describe '#get_rate' do
+    before(:each) do
+      @bank.flush_rates
+      @bank.store.add_rate(:EUR, :EUR, 1.0)
+    end
+
+    it 'should try to expire the rates' do
+      expect(@bank).to receive(:expire_rates).once
+      @bank.get_rate(:EUR, :EUR)
+    end
+
+    it 'should return the correct rate' do
+      expect(@bank.get_rate(:EUR, :EUR)).to eq(1.0)
+    end
+
+    context 'when rate is unknown' do
+      before(:each) do
+        @bank.flush_rates
+        allow(@bank).to receive(:fetch_rates) do
+          @bank.store.add_rate(:EUR, :EUR, 1.0)
+        end
+      end
+
+      it 'should call #fetch_rates' do
+        expect(@bank).to receive(:fetch_rates).once
+        @bank.get_rate(:EUR, :EUR)
+      end
+
+      it 'should store the rate for faster retreival' do
+        @bank.get_rate(:EUR, :EUR)
+        expect(@bank.store.instance_variable_get('@index'))
+          .to include('EUR_TO_EUR')
+      end
+
+      context 'when exhange rate is not found' do
+        it 'should raise UnknownRate error' do
+          expect { @bank.get_rate('VND', :USD) }
+            .to raise_error(Money::Bank::UnknownRate)
+        end
+      end
+    end
+
+    context 'when rate is known' do
+      it 'should not use #fetch_rates' do
+        expect(@bank).to_not receive(:fetch_rates)
+        @bank.get_rate(:EUR, :EUR)
+      end
+    end
+  end
+
+  describe '#flush_rates' do
+    before(:each) do
+      @bank.store.add_rate(:EUR, :EUR, 1.0)
+    end
+
+    it 'should empty @rates' do
+      @bank.get_rate(:EUR, :EUR)
+      @bank.flush_rates
+      expect(@bank.store.instance_variable_get('@index')).to eq({})
+    end
+  end
+
+  describe '#flush_rate' do
+    before(:each) do
+      allow(@bank).to(receive(:fetch_rates).once) do
+        @bank.store.add_rate('JPY', :EUR, 107)
+        @bank.store.add_rate(:USD, :EUR, 1.2)
+      end
+    end
+
+    it 'should remove a specific rate from @rates' do
+      @bank.get_rate(:USD, :JPY)
+      @bank.flush_rate(:USD, :EUR)
+      expect(@bank.store.instance_variable_get('@index'))
+        .to include('JPY_TO_EUR')
+      expect(@bank.store.instance_variable_get('@index'))
+        .to_not include('USD_TO_EUR')
+    end
+  end
+
+  describe '#expire_rates' do
+    before do
+      Money::Bank::FixerCurrency.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::FixerCurrency.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,9 @@
+require 'timecop'
+
+RSpec.configure do |config|
+end
+
+def load_rate_http_response(name)
+  f = File.expand_path("../rates/#{name}.html", __FILE__)
+  File.read(f, :encoding => 'iso-8859-1')
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fixer_currency
+version: !ruby/object:Gem::Version
+  version: 3.4.2
+platform: ruby
+authors:
+- Emily Wilson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  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: 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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.7'
+description: |-
+  FixerCurrency extends Money::Bank::Base and gives you access
+     to the current fixer.io exchange rates.
+email:
+- emilywilson@privy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gemtest"
+- AUTHORS
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- fixer_currency.gemspec
+- lib/money/bank/fixer_currency.rb
+- lib/money/rates_store/rate_removal_support.rb
+- spec/fixer_currency_with_json_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Privy/fixer_currency
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Access the fixer.io exchange rate data.
+test_files: []