active_currency 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6712c0205342cb855a5c816cbcf29a9d2d81266f12b34cf580055e4ad66977fe
-  data.tar.gz: a8b33afc0657a7164bffa81fc6d0fa7115c6863d30af7fe2f52b93d223a51998
+  metadata.gz: dc61cac61fcc7b74bf7288a1145b89af079cb527f49dc3991dd7147ebe5b824a
+  data.tar.gz: fc8da46d16ceae4822a6f6e3974c050bafa732122d5918276bc33b5fd09531ff
 SHA512:
-  metadata.gz: c138d27d24190e33af49618b03adbd2df9a2e3e72fc9b39ad7ad8e2ffefa47b6b73a17216221677732d7392b8b5998fb23b9b6ca8ba3f32f020372e63f924cf4
-  data.tar.gz: 36b38e8effcd0566ef0f6c4ed48d1d53d4da140a208673c3747e89a7afca32fd18f6a9405c2589f3b559ae91bf79f0e42e46ac276384a920a29f278c28d1a0a2
+  metadata.gz: 96554a896dd94c5b23d274c2805421dade360cec6f77eeba451f41f0be49783264f191dd23f555df0a54230c6eb387562577fb470580223af411b22211fbeaa2
+  data.tar.gz: 0e2b4b110edede9724552d7ff36c35d8f6c80cd0d8449950092a84452d1fe5f64043116ccfb3f8aef1a2e7b9793973c09e47546c11d9afa31e3d98b3ce0abaa2

data/README.md

@@ -1,14 +1,12 @@
 # ActiveCurrency
 
-[![CircleCI](https://circleci.com/gh/sunny/active_currency.svg?style=svg)](https://circleci.com/gh/sunny/active_currency)
-
 Rails plugin to retrieve and store the currency rates daily to integrate
-with the `money-rails` gem.
+with the [money-rails] gem.
 
 ## Rationale
 
-Storing the current currency rates in the database using ActiveCurrency
-provides the following advantages:
+Storing the current currency rates with ActiveCurrency provides the following
+advantages:
 
 - Lets you query for the currency rate you actually used in your application at
   any given time.
@@ -25,13 +23,11 @@ a call to the database.
 ## Usage
 
 Store the current rate regularly by calling in a scheduled job (using something
-like [sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler),
-[whenever](https://github.com/javan/whenever),
-or [active_scheduler](https://github.com/JustinAiken/active_scheduler))
-with the currencies you want to store:
+like [sidekiq-scheduler], [whenever], or [active_scheduler]) with the currencies
+you want to store:
 
 ```rb
-ActiveCurrency::AddRates.call(%w[EUR USD])
+ActiveCurrency::AddRates.call(currencies: %w[EUR USD])
 ```
 
 You can then exchange money by using the Money gem helpers:
@@ -51,7 +47,7 @@ ActiveCurrency::Rate.where(from: 'EUR', to: 'USD').pluck(:value)
 
 ## Installation
 
-Add these lines to your application's `Gemfile`:
+Add these lines to your application’s `Gemfile`:
 
 ```rb
 # Store and retrieve the currency from the database.
@@ -71,23 +67,52 @@ the currency rates and fill it for the first time.
 
 ## Fetching rates
 
-By defaut it uses the [eu_central_bank] to update the currency rates.
+Call the following regularly in a scheduled job:
+
+```rb
+ActiveCurrency::AddRates.call(currencies: %w[EUR USD])
+```
+
+The first currency you give in `currencies` is considered the default currency
+against which other currency rates will be guessed if they are unavailable.
+
+### Fetching from the European Central Bank
+
+By defaut it uses the [eu_central_bank] to fill the currency rates.
 
-If you prefer another API, you can provide any Money-compatible bank when
-calling `ActiveCurrency::AddRates`. For example with the
-[money-open-exchange-rates] gem:
+### Fetching from openexchangerates.org
+
+To use the [money-open-exchange-rates] gem, add the gem to your `Gemfile`, then
+add the following to your application’s initializers:
 
 ```rb
-require 'money/bank/open_exchange_rates_bank'
+ActiveCurrency.configure do |config|
+  config.remote_bank = :open_exchange_rates
+  config.open_exchange_rates_app_id = '…'
+end
+```
+
+### Fetching from a custom bank
 
-bank = Money::Bank::OpenExchangeRatesBank.new(Money::RatesStore::Memory.new)
-bank.app_id = '…'
+You can provide any Money-compatible bank when calling
+`ActiveCurrency::AddRates`:
 
-ActiveCurrency::AddRates.call(%w[EUR USD], bank: bank)
+```rb
+ActiveCurrency::AddRates.call(…, bank: …)
 ```
 
-The first currency you give to `AddRates` is considered the default currency
-against which other currency rates will be guessed if they are unavailable.
+## Apply a multiplier
+
+If you want to increase or decrease the currency rates by a given multiplier,
+you can do so by setting the `multiplier` option:
+
+```rb
+ActiveCurrency.configure do |config|
+  config.multiplier = {
+    ["EUR", "USD"] => 1.01,
+  }
+end
+```
 
 ## Tests
 
@@ -100,7 +125,7 @@ For that, you can use a fake rate store in your `rails_helper.rb`:
 MoneyRails.configure do |config|
   rate_store = Money::RatesStore::Memory.new.tap do |store|
     store.add_rate('USD', 'EUR', 1.5)
-    store.add_rate('EUR', 'USD', 1.4)
+    store.add_rate('EUR', 'USD', 0.67)
   end
   config.default_bank = Money::Bank::VariableExchange.new(rate_store)
 end
@@ -108,21 +133,20 @@ end
 
 ## Contributing
 
-Please file issues and pull requests
-[on GitHub](https://github.com/sunny/active_currency).
+Please file issues and pull requests [on GitHub].
 
 ## Development
 
 Install:
 
 ```sh
-BUNDLE_GEMFILE=Gemfile-rails6.0 bundle install
+BUNDLE_GEMFILE=Gemfile-rails7.0 bundle install
 ```
 
 Launch specs and linters:
 
 ```sh
-BUNDLE_GEMFILE=Gemfile-rails6.0 bin/rake
+BUNDLE_GEMFILE=Gemfile-rails7.0 bin/rake
 ```
 
 ## Release
@@ -132,22 +156,23 @@ Update `CHANGELOG.md`, update version in `lib/active_currency/version.rb`.
 Then:
 
 ```sh
-gem install bundler:1.17.2
-BUNDLE_GEMFILE=Gemfile-rails4.2 bundle update
-BUNDLE_GEMFILE=Gemfile-rails5.2 bundle update
-
-gem install bundler:2.1.2
-BUNDLE_GEMFILE=Gemfile-rails6.0 bundle update
+BUNDLE_GEMFILE=Gemfile-rails6.1 bundle update
+BUNDLE_GEMFILE=Gemfile-rails7.0 bundle update
 
-git add CHANGELOG.md lib/active_currency/version.rb Gemfile-rails*.lock
+git add CHANGELOG.md lib/active_currency/version.rb Gemfile-rails*
 git commit -m v`ruby -r./lib/active_currency/version <<< 'puts ActiveCurrency::VERSION'`
 bin/rake release
 ```
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
 
+[money-rails]: https://github.com/RubyMoney/money-rails
+[sidekiq-scheduler]: https://github.com/Moove-it/sidekiq-scheduler
+[whenever]: https://github.com/javan/whenever
+[active_scheduler]: https://github.com/JustinAiken/active_scheduler
 [eu_central_bank]: https://github.com/RubyMoney/eu_central_bank
 [money-open-exchange-rates]: https://github.com/spk/money-open-exchange-rates
+[on GitHub]: https://github.com/sunny/active_currency
+[MIT License]: http://opensource.org/licenses/MIT

data/db/migrate/20180911202100_create_active_currency_rates.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'active_currency/migration'
+require "active_currency/migration"
 
 class CreateActiveCurrencyRates < ActiveCurrency::Migration
+  # rubocop:disable Metrics/MethodLength
   def change
     create_table :active_currency_rates do |t|
       t.string :from
@@ -15,11 +16,12 @@ class CreateActiveCurrencyRates < ActiveCurrency::Migration
       dir.up do
         add_index :active_currency_rates,
                   %i[from to created_at],
-                  name: 'index_active_currency_rates'
+                  name: "index_active_currency_rates"
       end
       dir.down do
-        remove_index :active_currency_rates, 'index_active_currency_rates'
+        remove_index :active_currency_rates, "index_active_currency_rates"
       end
     end
   end
+  # rubocop:enable Metrics/MethodLength
 end

data/lib/active_currency/add_rates.rb

@@ -3,27 +3,41 @@
 module ActiveCurrency
   # Store the latest currency rates.
   class AddRates
-    def initialize(currencies, bank: EuCentralBank.new)
+    include AfterCommitEverywhere
+
+    def self.call(deprecated_currencies = nil, currencies: nil, bank: nil)
+      currencies ||= deprecated_currencies
+      bank ||= ActiveCurrency.remote_bank
+
+      new(currencies: currencies, bank: bank).send(:call)
+    end
+
+    private
+
+    def initialize(currencies:, bank:)
+      if currencies.size < 2
+        raise ArgumentError, "At least two currencies are required"
+      end
+
       @currencies = currencies.map(&:to_s).map(&:upcase)
       @bank = bank
     end
 
+    private_class_method :new
+
     def call
       bank.update_rates
 
-      rates_hash.each do |(from, to), rate|
-        store.add_rate(from, to, rate)
+      in_transaction do
+        rates_hash.each do |(from, to), rate|
+          rate = multiply_rate(from, to, rate)
+          store.add_rate(from, to, rate)
+        end
       end
 
       nil
     end
 
-    def self.call(currencies, *options)
-      new(currencies, *options).call
-    end
-
-    private
-
     attr_accessor :bank, :currencies
 
     def store
@@ -48,7 +62,7 @@ module ActiveCurrency
       inverse = hash[[to, from]]
       return 1.fdiv(inverse) if inverse
 
-      # Rate going through the first currency (desperate)
+      # Rate going through the main currency (desperate)
       from_main = hash[[from, main_currency]]
       to_main = hash[[main_currency, to]]
       return from_main * to_main if from_main && to_main
@@ -56,6 +70,10 @@ module ActiveCurrency
       raise "Unknown rate between #{from} and #{to}"
     end
 
+    def multiply_rate(from, to, rate)
+      rate * ActiveCurrency.configuration.multiplier.fetch([from, to], 1)
+    end
+
     def main_currency
       currencies.first
     end

data/lib/active_currency/cacheable_store.rb

@@ -4,6 +4,8 @@ module ActiveCurrency
   # Mixin to add caching capability to a rate store when getting the current
   # cache.
   module CacheableStore
+    include AfterCommitEverywhere
+
     def get_rate(from, to, date = nil)
       return super if date
 
@@ -15,13 +17,15 @@ module ActiveCurrency
     def add_rate(from, to, rate, date = nil)
       super
 
-      Rails.cache.delete(cache_key(from, to))
+      after_commit do
+        Rails.cache.delete(cache_key(from, to))
+      end
     end
 
     private
 
     def cache_key(from, to)
-      ['active_currency_rate', from, to]
+      ["active_currency_rate", from, to]
     end
   end
 end

data/lib/active_currency/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveCurrency
+  class Configuration
+    def initialize
+      @remote_bank = :eu_central_bank
+      @open_exchange_rates_app_id = nil
+      @multiplier = {}
+    end
+
+    attr_accessor :remote_bank,
+                  :open_exchange_rates_app_id,
+                  :multiplier
+  end
+end

data/lib/active_currency/engine.rb

@@ -8,7 +8,7 @@ module ActiveCurrency
       next if app.root.to_s.match(root.to_s)
 
       paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
-      config.paths['db/migrate'].expanded.each do |path|
+      config.paths["db/migrate"].expanded.each do |path|
         paths << path
       end
       paths.uniq!

data/lib/active_currency/migration.rb

@@ -2,7 +2,7 @@
 
 module ActiveCurrency
   # Helps support previous version of Rails in migrations.
-  if Rails.version > '5.0'
+  if Rails.version > "5.0"
     class Migration < ActiveRecord::Migration[5.0]; end
   else
     class Migration < ActiveRecord::Migration; end

data/lib/active_currency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveCurrency
-  VERSION = '1.3.0'
+  VERSION = "1.4.0"
 end

data/lib/active_currency.rb

@@ -1,14 +1,48 @@
 # frozen_string_literal: true
 
-require 'money-rails'
-require 'eu_central_bank'
+require "money-rails"
+require "after_commit_everywhere"
 
-require 'active_currency/engine'
-require 'active_currency/database_store'
-require 'active_currency/cacheable_store'
-require 'active_currency/rate_store'
-require 'active_currency/add_rates'
-require 'active_currency/bank'
+require "active_currency/configuration"
+require "active_currency/engine"
+require "active_currency/database_store"
+require "active_currency/cacheable_store"
+require "active_currency/rate_store"
+require "active_currency/add_rates"
+require "active_currency/bank"
 
 module ActiveCurrency
+  class << self
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def remote_bank
+      case configuration.remote_bank
+      when :eu_central_bank then eu_central_bank_instance
+      when :open_exchange_rates then open_exchange_rates_instance
+      end
+    end
+
+    private
+
+    def eu_central_bank_instance
+      require "eu_central_bank"
+
+      EuCentralBank.new
+    end
+
+    def open_exchange_rates_instance
+      require "money/bank/open_exchange_rates_bank"
+
+      store = Money::RatesStore::Memory.new
+      bank = Money::Bank::OpenExchangeRatesBank.new(store)
+      bank.app_id = configuration.open_exchange_rates_app_id
+      bank
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_currency
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Sunny Ripert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: after_commit_everywhere
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: eu_central_bank
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: money-open-exchange-rates
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-github
+  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_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +206,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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
@@ -179,6 +235,7 @@ files:
 - lib/active_currency/add_rates.rb
 - lib/active_currency/bank.rb
 - lib/active_currency/cacheable_store.rb
+- lib/active_currency/configuration.rb
 - lib/active_currency/database_store.rb
 - lib/active_currency/engine.rb
 - lib/active_currency/migration.rb
@@ -187,8 +244,9 @@ files:
 homepage: https://github.com/sunny/active_currency
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +261,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Rails plugin to store your currency regularly
 test_files: []