active_currency 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '079217f3be4857bdc2856432a807341a94eea305'
+  data.tar.gz: defcb92fec6e6124a0a5566c9f9c9040b7efe31a
+SHA512:
+  metadata.gz: bddbb54d3fbbae7b918bcb2eb90e024e7413f5656fe887f46ee3577a3af2089d1a1993575aa126bf78f62ec504f36c78ccad684c6899b0a15dedc1c3ffa8d73a
+  data.tar.gz: a0776af8effc2d92c9ff6df9a2e9679bf9cea1ae671002987202abe638c5a1b499a6d7817a6dcea534d16b33b2322efb8d0c1143559585f1c5c7e5964dae0309

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Sunny Ripert
+
+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,81 @@
+# ActiveCurrency
+
+Rails plugin to retrieve and store the currency rates daily to integrate
+with the `money-rails` gem.
+
+## Rationale
+
+Storing the current currency rates in the database using ActiveCurrency
+provides the following advantages:
+
+- Lets you find out what the currency rate you used in your application was
+  at any given time.
+- Does not need to call an API to get the rates when starting or restarting
+  your web server.
+- Choose how often you want to check for a currency (daily for example).
+- Your users do not suffer the cost of making calls to the bank rates API.
+- Your app does not go down when the bank rates API does.
+- When fetching the current rate, it uses your application cache in order not
+  to have to do a database query.
+
+## Usage
+
+Store the current rate regularly by calling in a scheduled job (using something
+like `sidekiq-scheduler` or `whenever`):
+
+```rb
+ActiveCurrency::AddRates.new.call
+```
+
+You can then exchange money by using the Money gem:
+
+```rb
+10.to_money('EUR').exchange_to('USD').cents
+```
+
+Or look up the currency rate:
+
+```rb
+ActiveCurrency::Rate.current_value_for('EUR', 'USD', 10.days.ago)
+# => 1.151
+ActiveCurrency::Rate.where(from: 'EUR', to: 'USD').pluck(:value)
+# => [1.162, 1.162, 1.161, 1.61, 1.63, …]
+```
+
+## Installation
+
+Add these lines to your application's `Gemfile`:
+
+```rb
+# Store and retrieve the currency from the database.
+gem 'active_currency',
+    git: 'git@github.com:sunny/active_currency.git'
+```
+
+And in `config/initializers/money.rb`:
+
+```rb
+MoneyRails.configure do |config|
+  rate_store = ActiveCurrency::RateStore.new(%w[EUR USD])
+  config.default_bank = Money::Bank::VariableExchange.new(rate_store)
+end
+```
+
+Then call `bundle exec rake db:migrate` to create the table that holds
+the currency rates and fill it for the first time.
+
+## Contributing
+
+Please file issues and pull requests
+[on GitHub](https://github.com/sunny/active_currency).
+
+In developemnt, launch specs and code linter by calling:
+
+```sh
+bundle exec rake
+```
+
+## 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,37 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveCurrency'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts 'RSpec load error'
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app/models/active_currency/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/active_currency/rate.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  class Rate < ApplicationRecord
+    validates :from,
+              :to,
+              inclusion: { in: ->(_v) { Money.default_bank.store.currencies } },
+              presence: true
+    validates :value, numericality: { greater_than: 0 }
+
+    scope :before, ->(date) { where(arel_table[:created_at].lt(date)) }
+
+    def self.current_value_for(from, to, date = nil)
+      scope = date ? before(date) : all
+
+      scope
+        .where(from: from, to: to)
+        .order(:created_at)
+        .last
+        &.value
+    end
+  end
+end

data/db/migrate/20180911202100_create_active_currency_rates.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateActiveCurrencyRates < ActiveRecord::Migration[5.0]
+  def change
+    create_table :active_currency_rates do |t|
+      t.string :from
+      t.string :to
+      t.float :value
+      t.datetime :created_at
+    end
+
+    add_index :active_currency_rates, %i[from to created_at]
+  end
+end

data/db/migrate/20180914064834_add_rates.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddRates < ActiveRecord::Migration[5.0]
+  def up
+    ActiveCurrency::AddRates.new.call
+  end
+end

data/lib/active_currency.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'money-rails'
+require 'eu_central_bank'
+
+require 'active_currency/engine'
+require 'active_currency/database_store'
+require 'active_currency/cacheable_store'
+require 'active_currency/rate_store'
+require 'active_currency/add_rates'
+
+module ActiveCurrency
+end

data/lib/active_currency/add_rates.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  # Store the latest currency rates.
+  class AddRates
+    def call
+      currencies = Money.default_bank.store.currencies.map(&:to_s) - ['EUR']
+      return if currencies.blank?
+
+      bank = EuCentralBank.new
+      bank.update_rates
+
+      from = 'EUR'
+      currencies.each do |to|
+        rate = bank.get_rate(from, to)
+
+        Money.add_rate(from, to, rate)
+        Money.add_rate(to, from, 1 / rate)
+      end
+    end
+  end
+end

data/lib/active_currency/cacheable_store.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  # Mixin to add caching capability to a rate store when getting the current
+  # cache.
+  module CacheableStore
+    def get_rate(from, to, date = nil)
+      return super if date
+
+      Rails.cache.fetch(cache_key(from, to)) do
+        super
+      end
+    end
+
+    def add_rate(from, to, rate, date = nil)
+      super
+
+      Rails.cache.delete(cache_key(from, to))
+    end
+
+    private
+
+    def cache_key(from, to)
+      ['active_currency_rate', from, to]
+    end
+  end
+end

data/lib/active_currency/database_store.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  # Currency Store that uses our ActiveRecord model to save and retrieve a
+  # value.
+  class DatabaseStore
+    def get_rate(from, to, date = nil)
+      ActiveCurrency::Rate.current_value_for(from, to, date)
+    end
+
+    def add_rate(from, to, rate, date = nil)
+      ActiveCurrency::Rate.create!(
+        from: from,
+        to: to,
+        value: rate,
+        created_at: date || Time.zone.now
+      )
+    end
+  end
+end

data/lib/active_currency/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveCurrency
+
+    initializer :append_migrations do |app|
+      # This prevents migrations from being loaded twice from the inside of the
+      # gem itself (dummy test app)
+      if app.root.to_s !~ /#{root}/
+        config.paths['db/migrate'].expanded.each do |migration_path|
+          app.config.paths['db/migrate'] << migration_path
+        end
+      end
+    end
+  end
+end

data/lib/active_currency/rate_store.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  class RateStore < DatabaseStore
+    include CacheableStore
+
+    attr_reader :currencies
+
+    def initialize(currencies)
+      @currencies = currencies
+    end
+  end
+end

data/lib/active_currency/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: active_currency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sunny Ripert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: money-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eu_central_bank
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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-rails
+  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: timecop
+  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: pry
+  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: rubocop
+  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'
+description: Store your currency.
+email:
+- sunny@sunfox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/active_currency/application_record.rb
+- app/models/active_currency/rate.rb
+- db/migrate/20180911202100_create_active_currency_rates.rb
+- db/migrate/20180914064834_add_rates.rb
+- lib/active_currency.rb
+- lib/active_currency/add_rates.rb
+- lib/active_currency/cacheable_store.rb
+- lib/active_currency/database_store.rb
+- lib/active_currency/engine.rb
+- lib/active_currency/rate_store.rb
+- lib/active_currency/version.rb
+homepage: https://github.com/sunny/active_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.6.11
+signing_key: 
+specification_version: 4
+summary: Rails plugin to store your currency regularly
+test_files: []