xrate 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38091bf237eb0b4f2a4547bd7e1252ad2b94c1bc0d34afe53e2339ebdffa7aac
+  data.tar.gz: f04b189d4f24013c8aa7b50d7afe32cbed09e615b404dbd9b2dcb63885801207
+SHA512:
+  metadata.gz: a5bbc4e89ac04305364dea713ad77253030abc067988783f1d4a75de7fc89feb0aed0c3d0626767c80fd8dab63e57ee9395f8069cb5c97d9dab155ebae27c469
+  data.tar.gz: c06f2f5bc45fff34ffe411026223ad0c3c4526bed433d8d633d5ce988ac13b351ba5ebf2edddb0ee62b06a131d4eccce93eb543a4d2618cf63427767cbb701d6

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby_version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in xrate.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    xrate (0.1.0)
+      nokogiri (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5)
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3)
+  xrate!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sam Ward
+
+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,52 @@
+# Xrate
+Xrate is a gem for Rails which provides historic exchange rate lookups against a base currency.
+
+This gem uses the European Central Bank 90 day historic rate feed as a source, but other sources can be used by storing the rates by creating Rate objects:
+
+`Xrate:Rate.create(date: Date.today, currency: "GBP", rate: 0.555)`
+
+Xrate will raise an exception if the conversion cannot be carried out due to lack of data.  You should plan to gracefully handle UnconvertableCurrencyExceptions in your app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "xrate"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xrate
+
+Xrate stores a cache of the current exhange rates in the database and assumes `ActiveRecord` is present.  To generate the migration for this table, run `rails generate xrate:install` and `rails db:migrate` to run the migration.
+
+Xrate assumes that all rates will be against a base currency defined in the environment variable "XRATE_BASE_CURRENCY".
+
+## Usage
+To get the last 90 days of exhange rate data from the [European Central Bank](http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml), run `rake xrate:import`.  This can be run on a regular basis to keep your rate cache up to date.  Note, Xrate will always take the last import as correct, overwriting any previous stored rates.
+
+Lookups are made by running `Xrate::ExchangeRate.at({date}, {source}, {target})`
+
+### Example
+To find out the how much £1 was worth in USD the day before brexit, you would run:
+
+`Xrate::ExchangeRate.at("2016-06-22", "GBP", "USD")`
+
+Xrate returns rates in [BigDecimal](https://ruby-doc.org/stdlib/libdoc/bigdecimal/rdoc/BigDecimal.html).
+
+## Roadmap
+- Add caching layer to prevent the need to hit the database for each lookup
+- Make ORM and framework-agnostic
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/samward/xrate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/Rakefile

@@ -0,0 +1,4 @@
+require "xrate"
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/generators/xrate/install/templates/create_xrate_exchange_rates.rb

@@ -0,0 +1,11 @@
+class CreateXrateExchangeRates < ActiveRecord::Migration
+  def change
+    create_table :xrate_exchange_rates do |t|
+      t.string   :currency, null: false
+      t.decimal  :rate, null: false
+      t.date     :date, null: false
+      t.timestamps
+    end
+    add_index :xrate_exchange_rates, [:date, :currency]
+  end
+end

data/lib/generators/xrate/install_generator.rb

@@ -0,0 +1,22 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Xrate
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../install/templates", __FILE__)
+      desc "Add the rate storage migration for Xrate"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_migrations
+        migration_template "create_xrate_exchange_rates.rb",
+          "db/migrate/create_xrate_exchange_rates.rb"
+      end
+    end
+  end
+end

data/lib/xrate.rb

@@ -0,0 +1,6 @@
+module Xrate
+  require "xrate/rate"
+  require "xrate/exchange_rate"
+  require "xrate/unconvertable_currency_exception"
+  require "xrate/railtie" if defined?(Rails)
+end

data/lib/xrate/exchange_rate.rb

@@ -0,0 +1,31 @@
+require "xrate/version"
+require "bigdecimal"
+require "unconvertable_currency_exception"
+
+module Xrate
+  class ExchangeRate
+    def self.at(date, from, target)
+      get_rate_at(date, from, target) or
+        raise Xrate::UnconvertableCurrencyException
+    end
+
+    def self.get_rate_at(date, from, target)
+      if from == ENV.fetch("XRATE_BASE_CURRENCY")
+        Xrate::Rate.where(date: date, currency: target).first&.rate
+      else
+        calculate_rate(date, from, target)
+      end
+    end
+
+    def self.calculate_rate(date, from, target)
+      begin
+        base_to_from = Xrate::Rate.where(date: date, currency: from).first&.rate
+        base_to_target = Xrate::Rate.where(date: date, currency: target).first&.rate
+
+        base_to_target / base_to_from
+      rescue NoMethodError # handle divide by zero
+        nil
+      end
+    end
+  end
+end

data/lib/xrate/railtie.rb

@@ -0,0 +1,13 @@
+require "xrate"
+require "rails"
+
+module Xrate
+  class Railtie < Rails::Railtie
+    railtie_name :xrate
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/xrate/rate.rb

@@ -0,0 +1,9 @@
+require "active_record"
+
+module Xrate
+  class Rate < ActiveRecord::Base
+    self.table_name = "xrate_exchange_rates"
+    validates :currency, uniqueness: { scope: :date }
+    validates :currency, :rate, :date, presence: true
+  end
+end

data/lib/xrate/tasks/import.rake

@@ -0,0 +1,28 @@
+require "nokogiri"
+require "open-uri"
+require "xrate"
+
+
+namespace :xrate do
+  desc "Fetch latest rates from ECB"
+  task import: :environment do
+    xml = open("http://www.ecb.europa.eu/stats/eurofxref/eurofxref-hist-90d.xml")
+    doc = Nokogiri::XML.parse(xml)
+    doc.remove_namespaces!
+    doc.xpath("//Cube[@time]").each do |day|
+      date = Date.parse(day.attributes["time"].value)
+      day.children.each do |entry|
+        currency = entry.attributes["currency"].value
+        exchange_rate = entry.attributes["rate"].value
+        rate = Xrate::Rate.find_or_create_by(date: date, currency: currency)
+        rate.rate = exchange_rate
+
+        if rate.save
+          puts "#{date} #{currency} #{exchange_rate} stored"
+        else
+          puts "Error: #{date} #{currency} #{exchange_rate} could not be stored"
+        end
+      end
+    end
+  end
+end

data/lib/xrate/unconvertable_currency_exception.rb

@@ -0,0 +1,4 @@
+module Xrate
+  class UnconvertableCurrencyException < StandardError
+  end
+end

data/lib/xrate/version.rb

@@ -0,0 +1,3 @@
+module Xrate
+  VERSION = "0.1.2"
+end

data/xrate.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xrate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xrate"
+  spec.version       = Xrate::VERSION
+  spec.authors       = ["Sam Ward"]
+  spec.email         = ["sam@s-ward.com"]
+
+  spec.summary       = %q{Enables historic currency conversion}
+  spec.description   = %q{Provides methods to fetch, cache and utilise historic exchange rates in your app.}
+  spec.homepage      = "https://github.com/samward/xrate"
+  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"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "lib/xrate"]
+
+  spec.add_dependency "nokogiri", "~> 1.8"
+  spec.add_development_dependency "activerecord", "~> 5"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: xrate
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Sam Ward
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: Provides methods to fetch, cache and utilise historic exchange rates
+  in your app.
+email:
+- sam@s-ward.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby_version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/Rakefile
+- lib/generators/xrate/install/templates/create_xrate_exchange_rates.rb
+- lib/generators/xrate/install_generator.rb
+- lib/xrate.rb
+- lib/xrate/exchange_rate.rb
+- lib/xrate/railtie.rb
+- lib/xrate/rate.rb
+- lib/xrate/tasks/import.rake
+- lib/xrate/unconvertable_currency_exception.rb
+- lib/xrate/version.rb
+- xrate.gemspec
+homepage: https://github.com/samward/xrate
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/xrate
+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: Enables historic currency conversion
+test_files: []