active_currency 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c07e2a76dae93079049c2140345f1e38a64d81ac
-  data.tar.gz: 179ad081203f6de02d2b44a74f1449d9eead1d52
+SHA256:
+  metadata.gz: 938c7b875052bf9d26b9ade8d9f1f268a94da7949a1685961a4265b01ed70a1c
+  data.tar.gz: cd167c1b911156c2025d75b29be92cfdfceed15aac7533b736db5bb63a59d3bc
 SHA512:
-  metadata.gz: e31ee097e49beaaad38f1c714d1893ca80a6b09b8ef1211bc37545d0470a000470b99e1b3583ee62f4be269e9e23d4eb7413a9ca8d2e31cc0d5c8d44e41ff9cf
-  data.tar.gz: 1258f0d28a6be18644b1d19452ede084f439257b50b35bab6138bef3c9b0fc5bfa9b8019c9ee53b85f83bf34c46a204be315f36b63209576558dfb05f2d7e5ac
+  metadata.gz: 51af4e890792d65780f3ce822ca6bef58465b2a34578b7edb0c6776d8d104ba569ef282dd7004715944e7d388b44a3935c5e0659ae87fdbf3f01ce1b36fd1cec
+  data.tar.gz: 2b66ea9433ccf5e35b54e22296b95a765dd9b249930e02c056d49afcc0c9f8a6731e7340db6db606fcbda33be7b4bc5d4f6fac53dc75dbae7e4a1b6991f634cc

data/README.md

@@ -1,5 +1,7 @@
 # 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.
 
@@ -8,34 +10,35 @@ with the `money-rails` gem.
 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.
+- Lets you query for the currency rate you actually used in your application 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).
+- Does not depend on the file system to store cached rates.
+- Choose how often you want to update the currency rates (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.
 
-To fetch the rates, it uses the [eu_central_bank] gem.
+To fetch the *current* rate it uses your application cache instead of making
+a call to the database.
 
 ## Usage
 
 Store the current rate regularly by calling in a scheduled job (using something
-like `sidekiq-scheduler` or `whenever`) 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])
 ```
 
-You can then exchange money by using the Money gem:
+You can then exchange money by using the Money gem helpers:
 
 ```rb
 10.to_money('EUR').exchange_to('USD').cents
 ```
 
-Or look up the currency rate:
+If you need to look up the previous currency rates:
 
 ```rb
 ActiveCurrency::Rate.value_for('EUR', 'USD', 1.month.ago)
@@ -61,21 +64,41 @@ MoneyRails.configure do |config|
 end
 ```
 
-Then call `bundle exec rake db:migrate` to create the table that holds
+Then call `bin/rake db:migrate` to create the table that holds
 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.
+
+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:
+
+```rb
+require 'money/bank/open_exchange_rates_bank'
+
+bank = Money::Bank::OpenExchangeRatesBank.new(Money::RatesStore::Memory.new)
+bank.app_id = '…'
+
+ActiveCurrency::AddRates.call(%w[EUR USD], bank: 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.
+
 ## Tests
 
 In your app test suite you may not want to have to fill your database to be
 able to exchange currencies.
 
-For that, you should use a fake rate store in `config/initializers/money.rb`:
+For that, you can use a fake rate store in your `rails_helper.rb`:
 
 ```rb
-if Rails.env.test?
+MoneyRails.configure do |config|
   rate_store = Money::RatesStore::Memory.new.tap do |store|
-    store.add_rate('USD', 'EUR', 0.5)
-    store.add_rate('EUR', 'USD', 1.5)
+    store.add_rate('USD', 'EUR', 1.5)
+    store.add_rate('EUR', 'USD', 1.4)
   end
   config.default_bank = Money::Bank::VariableExchange.new(rate_store)
 end
@@ -86,10 +109,38 @@ end
 Please file issues and pull requests
 [on GitHub](https://github.com/sunny/active_currency).
 
-In developemnt, launch specs and code linter by calling:
+## Development
+
+Install:
 
 ```sh
-BUNDLE_GEMFILE=Gemfile-rails3.2 bundle exec rspec && bundle exec rake
+BUNDLE_GEMFILE=Gemfile-rails6.0 bundle install
+```
+
+Launch specs and linters:
+
+```sh
+BUNDLE_GEMFILE=Gemfile-rails6.0 bin/rake
+```
+
+## Release
+
+Update `CHANGELOG.md`, update version in `lib/active_currency/version.rb`.
+
+Then:
+
+```sh
+gem install bundler:1.3.0
+BUNDLE_GEMFILE=Gemfile-rails3.2 bundle update
+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
+
+git add CHANGELOG.md lib/active_currency/version.rb Gemfile-rails*.lock
+git commit -m v`ruby -r./lib/active_currency/version <<< 'puts ActiveCurrency::VERSION'`
+bin/rake release
 ```
 
 ## License
@@ -98,3 +149,4 @@ The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
 
 [eu_central_bank]: https://github.com/RubyMoney/eu_central_bank
+[money-open-exchange-rates]: https://github.com/spk/money-open-exchange-rates

data/app/models/active_currency/rate.rb

@@ -2,18 +2,22 @@
 
 module ActiveCurrency
   class Rate < ActiveRecord::Base
-    validates :from,
-              :to,
-              presence: true
+    validates :from, presence: true
+    validates :to, presence: true
     validates :value, numericality: { greater_than: 0 }
 
-    scope :before, ->(date) { where(arel_table[:created_at].lt(date)) }
+    scope :before, ->(date) {
+      where(arel_table[:created_at].lt(date))
+    }
 
     def self.value_for(from, to, date = nil)
-      scope = date ? before(date) : all_scope
+      from = Money::Currency.new(from)
+      to = Money::Currency.new(to)
+      return 1 if from == to
 
+      scope = date ? before(date) : all_scope
       scope
-        .where(from: from, to: to)
+        .where(from: from.iso_code, to: to.iso_code)
         .order(:created_at)
         .last
         &.value

data/db/migrate/20180911202100_create_active_currency_rates.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_currency/migration'
+
 class CreateActiveCurrencyRates < ActiveCurrency::Migration
   def change
     create_table :active_currency_rates do |t|
@@ -9,6 +11,8 @@ class CreateActiveCurrencyRates < ActiveCurrency::Migration
       t.datetime :created_at
     end
 
-    add_index :active_currency_rates, %i[from to created_at]
+    add_index :active_currency_rates,
+              %i[from to created_at],
+              name: 'index_active_currency_rates'
   end
 end

data/lib/active_currency.rb

@@ -3,7 +3,6 @@
 require 'money-rails'
 require 'eu_central_bank'
 
-require 'active_currency/migration'
 require 'active_currency/engine'
 require 'active_currency/database_store'
 require 'active_currency/cacheable_store'

data/lib/active_currency/add_rates.rb

@@ -3,36 +3,61 @@
 module ActiveCurrency
   # Store the latest currency rates.
   class AddRates
-    def initialize(currencies)
-      @currencies = currencies
+    def initialize(currencies, bank: EuCentralBank.new)
+      @currencies = currencies.map(&:to_s).map(&:upcase)
+      @bank = bank
     end
 
     def call
-      bank = EuCentralBank.new
       bank.update_rates
 
-      from = 'EUR'
-      currencies.map(&:to_s).each do |to|
-        next if to == from
-
-        rate = bank.get_rate(from, to)
+      rates_hash.each do |(from, to), rate|
         store.add_rate(from, to, rate)
-        store.add_rate(to, from, 1 / rate)
       end
+
+      nil
     end
 
-    def self.call(currencies)
-      new(currencies).call
+    def self.call(currencies, *options)
+      new(currencies, *options).call
     end
 
     private
 
-    def currencies
-      @currencies.map(&:to_s).map(&:upcase)
-    end
+    attr_accessor :bank, :currencies
 
     def store
       @store ||= ActiveCurrency::RateStore.new
     end
+
+    def rates_hash
+      currencies.each_with_object({}) do |from, hash|
+        currencies.each do |to|
+          next if from == to
+
+          hash[[from, to]] = get_rate(hash, from, to)
+        end
+      end
+    end
+
+    def get_rate(hash, from, to)
+      rate = bank.get_rate(from, to)
+      return rate if rate
+
+      # Inverse rate (not so good)
+      inverse = hash[[to, from]]
+      return 1.fdiv(inverse) if inverse
+
+      # Rate going through the first currency (desperate)
+      from_main = hash[[from, main_currency]]
+      to_main = hash[[main_currency, to]]
+      return from_main * to_main if from_main && to_main
+
+      raise "Unknown rate between #{from} and #{to}"
+    end
+
+    def main_currency
+      currencies.first
+    end
   end
 end

data/lib/active_currency/engine.rb

@@ -5,13 +5,13 @@ module ActiveCurrency
     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
+      next if app.root.to_s.match(root.to_s)
+
+      paths = ActiveRecord::Migrator.migrations_paths
+      config.paths['db/migrate'].expanded.each do |path|
+        paths << path
       end
+      paths.uniq!
     end
   end
 end

data/lib/active_currency/migration.rb

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

data/lib/active_currency/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_currency
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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
@@ -122,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-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'
 description: Store your currency.
 email:
 - sunny@sunfox.org
@@ -161,8 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails plugin to store your currency regularly