xe_currency 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8bca0457f3d2ce4e44ccb2ebbb2befe123018317
+  data.tar.gz: 3af1b1f671e089ef3298ca27bd6999f20f8a7d94
+SHA512:
+  metadata.gz: 52458ea2e80438b5609e8e76b547ceee49453b0cdbccdd84c44dd2c24b43612a69ca9e31d159071194bbc16ef302b027dfc44a327c1980843d40c61e9169a3de
+  data.tar.gz: bdac0e614ec9a62bce067fa9c717d44158a7d91ae3f7d3fe2a981f803e74a47f40df35bad678e0fa4ad7d274548d0ab6286c1988e30daa646c9c48ec99940def

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Salzberg
+
+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,34 @@
+# XeCurrency
+
+This gem extends Money::Bank::VariableExchange with Money::Bank::XeCurrency and
+gives you access to the current rates from the XE currency converter.
+
+Usage
+-----
+
+```ruby
+require 'money'
+require 'money/bank/xe_currency'
+
+# (optional)
+# set the seconds after than the current rates are automatically expired
+# by default, they never expire
+Money::Bank::XeCurrency.ttl_in_seconds = 86400
+
+# set default bank to instance of XeCurrency
+Money.default_bank = Money::Bank::XeCurrency.new
+
+# 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)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/money/bank/xe_currency.rb

@@ -0,0 +1,163 @@
+require 'money'
+require 'money/rates_store/rate_removal_support'
+require 'open-uri'
+require "nokogiri"
+
+class Money
+  module Bank
+    class XeCurrency < Money::Bank::VariableExchange
+      # Raised when there is an unexpected error in extracting exchange rates
+      # from Xe Finance Calculator
+      class XeCurrencyFetchError < Error
+      end
+
+      SERVICE_HOST = "www.xe.com"
+      SERVICE_PATH = "/currencyconverter/convert"
+
+      # @return [Hash] Stores the currently known rates.
+      attr_reader :rates
+
+
+      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(*)
+        super
+        @store.extend Money::RatesStore::RateRemovalSupport
+      end
+
+      ##
+      # Clears all rates stored in @rates
+      #
+      # @return [Hash] The empty @rates Hash.
+      #
+      # @example
+      #   @bank = XeCurrency.new  #=> <Money::Bank::XeCurrency...>
+      #   @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 = XeCurrency.new    #=> <Money::Bank::XeCurrency...>
+      #   @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 = XeCurrency.new  #=> <Money::Bank::XeCurrency...>
+      #   @bank.get_rate(:USD, :EUR)  #=> 0.776337241
+      def get_rate(from, to)
+        expire_rates
+        store.get_rate(from, to) || store.add_rate(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
+        rate = extract_rate(data);
+
+        if (rate < 0.1)
+          rate = 1/extract_rate(build_uri(to, from).read)
+        end
+
+        rate
+      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)
+        uri = URI::HTTP.build(
+          :host  => SERVICE_HOST,
+          :path  => SERVICE_PATH,
+          :query => "Amount=1&From=#{from.iso_code}&To=#{to.iso_code}"
+        )
+      end
+
+      ##
+      # Takes the response from Xe and extract the rate.
+      #
+      # @param [String] data The xe rate string to decode.
+      #
+      # @return [BigDecimal]
+      def extract_rate(data)
+        rate = ::Nokogiri::HTML(data).css('.uccResultAmount')[0].inner_text
+        BigDecimal(rate)
+      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/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "xe_currency"

data/spec/xe_currency_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe XeCurrency do
+  it "has a version number" do
+    expect(XeCurrency::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/xe_currency.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "xe_currency"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Chris Salzberg"]
+  spec.email         = ["csalzberg@degica.com"]
+
+  spec.summary       = %q{Access XE currency rate data.}
+  spec.homepage      = "https://github.com/degica/xe_currency"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+#    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.add_dependency "money", "~> 6.7"
+  spec.add_dependency "nokogiri", "~> 1.7", ">= 1.7.2"
+
+  spec.files =  Dir.glob("{lib,spec}/**/*")
+  spec.files += %w(LICENSE.txt README.md)
+  spec.files += %w(Rakefile xe_currency.gemspec)
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: xe_currency
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- csalzberg@degica.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/money/bank/xe_currency.rb
+- lib/money/rates_store/rate_removal_support.rb
+- spec/spec_helper.rb
+- spec/xe_currency_spec.rb
+- xe_currency.gemspec
+homepage: https://github.com/degica/xe_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.5.1
+signing_key: 
+specification_version: 4
+summary: Access XE currency rate data.
+test_files: []