money-oxr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4bd37837495d074315c1d36f74eda52210f8500
+  data.tar.gz: 974de53313238e11c02da30fb18a39c45beca679
+SHA512:
+  metadata.gz: 59c86351dab9217c7554a81817f79591e3f227424ee70a3923ea4c50ed1e8a18ff06a8b0f6dd0f1ab61148e0b2c7d9305ca2a18413458abb7fd0840e0e054f61
+  data.tar.gz: 56934936045e5a15bba1d470afc0807ef48be130a15b1f08d72408324858363b1c2d4463c92f4494ece67073614a289c14f2496914721b3a12a00b03c2eee0a5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 money-oxr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ed Lebert
+
+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,83 @@
+# Money::Oxr
+
+A Money-compatible rate store that uses exchange rates from openexchangerates.org.
+
+A few improvements over the existing money-open-exchange-rates gem:
+
+* Uses BigDecimal instead of Float for exchange rates.
+* Automatically caches API results to file if a :cache_path option is provided.
+* Automatically fetches new data from API if data becomes stale if a :max_age option is provided.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-oxr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-oxr
+
+## Usage
+
+With the gem, you do not need to manually add exchange rates. Calling load will
+load the rates from the cache file or download the rates from the API depending
+on your options.  The :source option defaults to
+
+``` ruby
+require 'money_oxr/bank'
+oxr_bank = MoneyOXR::Bank.new(
+  app_id: 'abcd1234',
+  cache_path: 'tmp/oxr.json',
+  max_age: 86400
+)
+oxr_bank.store.load
+Money.default_bank = oxr_bank
+```
+
+If you only want to load data from a file without ever fetching from the API,
+the :app_id and :max_age options are not necessary.
+
+``` ruby
+require 'money_oxr/bank'
+oxr_bank = MoneyOXR::Bank.new(
+  cache_path: 'config/oxr.json'
+)
+oxr_bank.store.load
+Money.default_bank = oxr_bank
+```
+
+If you are on a paid plan from openexchangerates.org and you wish to use a different
+source currency, you may provide it with the :source option.
+
+``` ruby
+require 'money_oxr/bank'
+oxr_bank = MoneyOXR::Bank.new(
+  app_id: 'abcd1234',
+  cache_path: 'tmp/oxr.json',
+  max_age: 86400,
+  source: 'GBP'
+)
+oxr_bank.store.load
+Money.default_bank = oxr_bank
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/edlebert/money-oxr.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "money/oxr"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/money_oxr/bank.rb

@@ -0,0 +1,12 @@
+require 'money_oxr/rates_store'
+require 'money/bank/variable_exchange'
+
+module MoneyOXR
+  class Bank < Money::Bank::VariableExchange
+
+    def initialize(options={}, &block)
+      super(MoneyOXR::RatesStore.new(options), &block)
+    end
+
+  end
+end

data/lib/money_oxr/rates_store.rb

@@ -0,0 +1,106 @@
+require 'money/rates_store/memory'
+require 'json'
+require 'bigdecimal'
+require 'open-uri'
+
+module MoneyOXR
+  class RatesStore < Money::RatesStore::Memory
+
+    class UnsupportedCurrency < StandardError; end
+
+    attr_reader :app_id, :source, :cache_path, :last_updated_at, :max_age
+
+    def initialize(*)
+      super
+      @app_id = options[:app_id]
+      @source = options[:source] || 'USD'
+      @cache_path = options[:cache_path]
+      @max_age = options[:max_age]
+    end
+
+    def get_rate(iso_from, iso_to)
+      load
+      super || begin
+        if iso_from == source
+          raise UnsupportedCurrency.new(iso_to)
+        elsif inverse_rate = super(iso_to, iso_from)
+          add_rate(iso_from, iso_to, 1 / inverse_rate)
+        elsif iso_to == source
+          raise UnsupportedCurrency.new(iso_from)
+        else
+          rate1 = get_rate(iso_from, source)
+          rate2 = get_rate(source, iso_to)
+          add_rate(iso_from, iso_to, rate1 * rate2)
+        end
+      end
+    end
+
+    def loaded?
+      index.any?
+    end
+
+    def load
+      # Loads data and ensures it is not stale.
+      if !loaded? && cache_path && File.exist?(cache_path)
+        load_from_cache_path
+      end
+      if app_id && (!loaded? || stale?)
+        load_from_api
+      end
+    end
+
+    def stale?
+      return false if !max_age
+      return true if last_updated_at.nil?
+      last_updated_at + max_age < Time.now
+    end
+
+    def load_from_api
+      json = get_json_from_api
+      if cache_path
+        write_cache_file(json)
+        load_from_cache_path
+      else
+        load_json(json)
+      end
+    end
+
+    def get_json_from_api
+      open(api_uri).read
+    end
+
+    def api_uri
+      "https://openexchangerates.org/api/latest.json?source=#{source}&app_id=#{app_id}"
+    end
+
+    def load_from_cache_path
+      load_json(File.read(cache_path))
+    end
+
+    def write_cache_file(text)
+      File.open(cache_path, 'w') { |file| file.write text }
+    end
+
+    def load_json(text)
+      data = parse_json(text)
+      transaction do
+        @last_updated_at = Time.at(data['timestamp'])
+        index.clear
+        data['rates'].each do |iso_to, rate|
+          add_rate(source, iso_to, rate)
+        end
+      end
+    end
+
+    def parse_json(text)
+      # Convert text to strings so that we can use BigDecimal instead of Float
+      text = text.gsub(/("[A-Z]{3}": ?)(\d+\.\d+)/, '\\1"\\2"')
+      data = JSON.parse(text)
+      data['rates'] = data['rates'].each_with_object({}) do |(key, value), rates|
+        rates[key] = BigDecimal.new(value)
+      end
+      data
+    end
+
+  end
+end

data/money-oxr.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "money-oxr"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Ed Lebert"]
+
+  spec.summary       = %q{A Money-compatible rate store that uses exchange rates from openexchangerates.org.}
+  spec.homepage      = "https://github.com/edlebert/money-oxr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^spec/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "money", "~> 6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.3"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: money-oxr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ed Lebert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/money_oxr/bank.rb
+- lib/money_oxr/rates_store.rb
+- money-oxr.gemspec
+homepage: https://github.com/edlebert/money-oxr
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A Money-compatible rate store that uses exchange rates from openexchangerates.org.
+test_files: []