active_currency 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e714ea208f9bd8ebded58b96bde8497a9f9c47c2
-  data.tar.gz: fdd79e4b7ed274966cc932f7f4ba8536040ba02c
+SHA256:
+  metadata.gz: 6712c0205342cb855a5c816cbcf29a9d2d81266f12b34cf580055e4ad66977fe
+  data.tar.gz: a8b33afc0657a7164bffa81fc6d0fa7115c6863d30af7fe2f52b93d223a51998
 SHA512:
-  metadata.gz: ef833fcd22cf76b2511ff68a4930d1026e3687c129674abb6f96a79b2fdd64899f5c962d9fe582c911f10835c6d40363199a3876e0669e48d17c69982a734864
-  data.tar.gz: f2d8a04600e685729c538a47323c43504a7ad939ade1b425c1e940e5acdd9d09d9ad639dbbfa0b7dcd16e3a71945a0799314f1e02cdc6c4ed9951cfba6b74a4f
+  metadata.gz: c138d27d24190e33af49618b03adbd2df9a2e3e72fc9b39ad7ad8e2ffefa47b6b73a17216221677732d7392b8b5998fb23b9b6ca8ba3f32f020372e63f924cf4
+  data.tar.gz: 36b38e8effcd0566ef0f6c4ed48d1d53d4da140a208673c3747e89a7afca32fd18f6a9405c2589f3b559ae91bf79f0e42e46ac276384a920a29f278c28d1a0a2

data/README.md

@@ -10,21 +10,25 @@ 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.
 
-To fetch the rates, it uses the [eu_central_bank] gem and uses your application
-cache when getting the current rate in order to save on database queries.
+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](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:
 
 ```rb
 ActiveCurrency::AddRates.call(%w[EUR USD])
@@ -62,9 +66,29 @@ 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
@@ -92,13 +116,32 @@ Please file issues and pull requests
 Install:
 
 ```sh
-BUNDLE_GEMFILE=Gemfile-rails4.2 bundle install
+BUNDLE_GEMFILE=Gemfile-rails6.0 bundle install
 ```
 
 Launch specs and linters:
 
 ```sh
-BUNDLE_GEMFILE=Gemfile-rails4.2 bundle exec rake
+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.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
+
+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
@@ -107,3 +150,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

@@ -11,18 +11,16 @@ module ActiveCurrency
     }
 
     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
-        .where(from: from, to: to)
+        .where(from: from.iso_code, to: to.iso_code)
         .order(:created_at)
         .last
         &.value
     end
-
-    # Scope retrocompatibility for Rails 3.2.
-    def self.all_scope
-      respond_to?(:scoped) ? scoped : all
-    end
   end
 end

data/db/migrate/20180911202100_create_active_currency_rates.rb

@@ -11,8 +11,15 @@ class CreateActiveCurrencyRates < ActiveCurrency::Migration
       t.datetime :created_at
     end
 
-    add_index :active_currency_rates,
-              %i[from to created_at],
-              name: 'index_active_currency_rates'
+    reversible do |dir|
+      dir.up do
+        add_index :active_currency_rates,
+                  %i[from to created_at],
+                  name: 'index_active_currency_rates'
+      end
+      dir.down do
+        remove_index :active_currency_rates, 'index_active_currency_rates'
+      end
+    end
   end
 end

data/lib/active_currency/add_rates.rb

@@ -3,51 +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
-      other_currencies.each do |to|
-        store_rate(from, to)
+      bank.update_rates
+
+      rates_hash.each do |(from, to), rate|
+        store.add_rate(from, to, rate)
       end
-    end
 
-    def self.call(currencies)
-      new(currencies).call
+      nil
     end
 
-    private
-
-    def currencies
-      @currencies.map(&:to_s).map(&:upcase)
+    def self.call(currencies, *options)
+      new(currencies, *options).call
     end
 
-    def other_currencies
-      currencies - [from]
-    end
+    private
 
-    def from
-      'EUR'
-    end
+    attr_accessor :bank, :currencies
 
     def store
       @store ||= ActiveCurrency::RateStore.new
     end
 
-    def bank
-      @bank ||= EuCentralBank.new.tap(&:update_rates)
+    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 store_rate(from, to)
+    def get_rate(hash, from, to)
       rate = bank.get_rate(from, to)
+      return rate if rate
 
-      if rate.nil? || rate.zero?
-        raise "Bank rate must be set but bank returned #{rate.inpsect}"
-      end
+      # 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
 
-      store.add_rate(from, to, rate)
-      store.add_rate(to, from, 1.fdiv(rate))
+    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::Tasks::DatabaseTasks.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.1'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_currency
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Sunny Ripert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: money-rails
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,30 @@ dependencies:
   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: 1.3.6
+        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: 1.3.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -136,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
@@ -175,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