money-exchange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e63d096b40d37d57fc4d1856c891b82736d1adae0aded2dd3d026e67ff4aadf9
+  data.tar.gz: 182d0ddd00ea2211b6a97ad38892094a2865bd955ad41e8f447bcc45e1c8e8cd
+SHA512:
+  metadata.gz: 7979f0ad7d1688018b4aa7b9007ba6fa43a613e969c2688a5ebd0904b61f6b66aa62fbfa61f68ff7d6ee4c77dec11c8fdbf82f8d0ce8062361990e17fa2fd5e1
+  data.tar.gz: 48a2150e88798dbe170b5ba84514cc36563c8a4788b39b23b8bc9d70a8614a16b5b393648c6f5cc21652877f1cc4d30ffe9240a4ee2138b8a8620b954d574aa2

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/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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-exchange.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    money-exchange (0.1.0)
+      money (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    money (6.12.0)
+      i18n (>= 0.6.4, < 1.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  money-exchange!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop (~> 0.9.1)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,90 @@
+# MoneyExchange
+
+Money gem integration with Open Exchange Rates API.
+
+Development goals:
+
+* seamless integration with `money` gem
+* flexible caching
+* Open Exchange Rates API quota protection
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'money-exchange'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install money-exchange
+
+## Usage
+
+Create and configure `MoneyExchange::Bank` and set it as `Money.default_bank`.
+
+```ruby
+require 'money_exchange'
+
+bank = MoneyExchange::Bank.new(
+  client: MoneyExchange::Client::OXR.new(ENV['OXR_APP_ID']),
+  ttl: 24 * 60 * 60
+)
+
+Money.default_bank = bank
+```
+
+It will make `Money` use it transparently for currency conversion.
+
+```ruby
+Money.new(10000, 'USD').exchange_to('EUR')
+# => #<Money fractional:85 currency:EUR>
+```
+
+### Caching
+
+Exchange rates are cached internally on the rates store level for the number of seconds set with `ttl` option (defaults to 24 hours). If you want to use external cache store, e.g. the same as used in your Rails application, provide it as `cache_store` option.
+
+```ruby
+MoneyExchange::Bank.new(
+  cache_store: Rails.cache,
+  ttl: 12 * 60 * 60
+)
+```
+
+### Open Exchange Rates API limits
+
+OXR imposes usage limits in their API. In order to protect your quota, don't use the actual API in `development` or `test` environments. Instead configure the bank to use the local client preloaded with locally cached (sample) data.
+
+Just save a response from https://openexchangerates.org/api/latest.json?app_id=OXR_APP_ID locally and load it when configuring the bank.
+
+```ruby
+data = JSON.parse(File.read("path/to/oxr-response.json"))
+
+MoneyExchange::Bank.new(
+  client: MoneyExchange::Client::Local.new(data)
+)
+```
+
+## 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/szajbus/money-exchange. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Money::Exchange project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/money-exchange/blob/master/CODE_OF_CONDUCT.md).

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_exchange"
+
+# 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_exchange.rb

@@ -0,0 +1,9 @@
+require "money_exchange/bank"
+require "money_exchange/cache/null_store"
+require "money_exchange/client/local"
+require "money_exchange/client/oxr"
+require "money_exchange/store"
+require "money_exchange/version"
+
+module MoneyExchange
+end

data/lib/money_exchange/bank.rb

@@ -0,0 +1,9 @@
+require 'money/bank/variable_exchange'
+
+module MoneyExchange
+  class Bank < Money::Bank::VariableExchange
+    def initialize(opts = {}, &blk)
+      super(MoneyExchange::Store.new(opts), &blk)
+    end
+  end
+end

data/lib/money_exchange/cache/null_store.rb

@@ -0,0 +1,17 @@
+module MoneyExchange
+  module Cache
+    class NullStore
+      def read(*args)
+        nil
+      end
+
+      def write(*args)
+        nil
+      end
+
+      def fetch(*args)
+        nil
+      end
+    end
+  end
+end

data/lib/money_exchange/client/local.rb

@@ -0,0 +1,11 @@
+module MoneyExchange
+  module Client
+    class Local
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+      end
+    end
+  end
+end

data/lib/money_exchange/client/oxr.rb

@@ -0,0 +1,25 @@
+require 'uri'
+
+module MoneyExchange
+  module Client
+    class OXR
+      ENDPOINT = 'https://openexchangerates.org/api/'.freeze
+
+      def initialize(app_id, iso_base = 'USD')
+        @app_id = app_id
+        @iso_base = iso_base
+      end
+
+      def data
+        uri =
+          URI.join(ENDPOINT, 'latest.json').tap do |uri|
+            uri.query = "app_id=#{@app_id}"
+            uri.query += "&base=#{@iso_base}" if @iso_base
+          end.to_s
+
+        response = open(uri)
+        JSON.parse(response)
+      end
+    end
+  end
+end

data/lib/money_exchange/store.rb

@@ -0,0 +1,64 @@
+require 'money/rates_store/memory'
+
+module MoneyExchange
+  class Store < Money::RatesStore::Memory
+    CACHE_KEY = 'MoneyExchange::Store/cache'.freeze
+
+    def initialize(opts = {})
+      super
+
+      @client      = opts[:client]
+      @cache_store = opts[:cache_store] || Cache::NullStore.new
+      @ttl         = opts[:ttl] || 24 * 60 * 60
+      @loaded_at   = nil
+      @iso_base    = nil
+    end
+
+    def get_rate(iso_from, iso_to)
+      load_rates! if stale?
+
+      super || begin
+        rate =
+          if iso_from == @iso_base
+            nil
+          elsif inverse_rate = super(iso_to, iso_from)
+            1.0 / inverse_rate
+          elsif iso_to == @iso_base
+            nil
+          else
+            get_rate(iso_from, @iso_base) * get_rate(@iso_base, iso_to)
+          end
+
+        add_rate(iso_from, iso_to, rate)
+      end
+    end
+
+    private
+
+    def load_rates!
+      data = @cache_store.read(CACHE_KEY)
+
+      unless data
+        data = @client.data
+
+        expires_in = data['timestamp'] + @ttl - Time.now.to_i
+        @cache_store.write(CACHE_KEY, data, expires_in: expires_in)
+      end
+
+      @iso_base = data['base']
+
+      transaction do
+        index.clear
+        data['rates'].each do |iso_to, rate|
+          add_rate(@iso_base, iso_to, rate)
+        end
+      end
+
+      @loaded_at = Time.now.to_i
+    end
+
+    def stale?
+      @loaded_at.nil? || (@loaded_at + @ttl < Time.now.to_i)
+    end
+  end
+end

data/lib/money_exchange/version.rb

@@ -0,0 +1,3 @@
+module MoneyExchange
+  VERSION = "0.1.0"
+end

data/money-exchange.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "money_exchange/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "money-exchange"
+  spec.version       = MoneyExchange::VERSION
+  spec.authors       = ["Michał Szajbe"]
+  spec.email         = ["michal.szajbe@gmail.com"]
+
+  spec.summary       = %q{Money gem integration with Open Exchange Rates API}
+  spec.description   = %q{This gem provides money-gem-compatible rates store connected to Open Exchange Rates API. It offers flexible caching mechanisms and OXR API quota protection.}
+  spec.homepage      = "https://github.com/szajbus/money-exchange"
+  spec.license       = "MIT"
+
+  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"]
+
+  spec.add_dependency "money", "~> 6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: money-exchange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Szajbe
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-23 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.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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: This gem provides money-gem-compatible rates store connected to Open
+  Exchange Rates API. It offers flexible caching mechanisms and OXR API quota protection.
+email:
+- michal.szajbe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/money_exchange.rb
+- lib/money_exchange/bank.rb
+- lib/money_exchange/cache/null_store.rb
+- lib/money_exchange/client/local.rb
+- lib/money_exchange/client/oxr.rb
+- lib/money_exchange/store.rb
+- lib/money_exchange/version.rb
+- money-exchange.gemspec
+homepage: https://github.com/szajbus/money-exchange
+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: Money gem integration with Open Exchange Rates API
+test_files: []