spree_multi_currency 1.0.4

data.tar.gz.sig

@@ -0,0 +1,3 @@
+4��A5�-8�cQb���E$!����DA+Cr{|����N��:�4��f�tt��~��l.��k?��A���~
+��ڑ�����9{�T7a
b�SSH6e_3íS9]~K��3��J������tuh�&�h�
p��7�*��;���g�O��kD��� ��ݡ�V�A��N]��g�j��k͢.K��j��mgn\!؛vB�j���a�ﺴ�%D�p}Y
�
+z�Y�X���+dP�

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/dummy

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem 'sqlite3'
+
+group :test do
+  gem 'rspec-rails', '= 2.6.1'
+  gem 'factory_girl'
+  gem 'faker'
+end
+
+gemspec

data/README.markdown

@@ -0,0 +1,196 @@
+# Spree Multi-Currency
+
+Support different currency and recalculate price from one to another
+
+Installation
+---------
+Add to Gemfile
+
+    gem "spree_multi_currency", :git => "git://github.com/pronix/spree-multi-currency.git"
+
+Run
+---
+Install the migrations for two new tables (currencies and currency conversion rates):
+
+    rake spree_multi_currency:install:migrations
+    rake db:migrate
+
+Load currencies:
+---------------
+Load up the list of all international currencies with corresponding codes:
+
+    rake spree_multi_currency:currency:iso4217         # Load currency ISO4217 table from Wikipedia http://en.wikipedia.org/wiki/ISO_4217
+    rake spree_multi_currency:currency:okv             # Central Bank of Russian Federation
+
+This step is not obligatory, i.e. you can manually fill up the 'currencies' table, but it's more practical to load the list with rake task above (and be sure the codes are OK), and then remove the currencies you don't want to support.
+
+
+If you want get amount in base currency use base_total
+
+Load rates:
+----------
+*Warning* Rates are being calculated relative to currency configured as 'basic'. It is therefore obligatory to visit Spree admin panel (or use Rails console) and edit one of the currencies to be the 'basic' one.
+
+Basic currency is also the one considered to be stored as product prices, shipment rates etc., from which all the other ones will be calculated using the rates.
+
+After setting the basic currency, time to load the rates using one of the rake tasks below. There are three sources of conversion rates supported by this extension:
+
+1. Rates from Central Bank of Russian Federation http://www.cbr.ru. These assume Russian Ruble is your basic currency:
+
+        rake spree_multi_currency:rates:cbr
+
+2. Rates from European Central Bank. These assume Euro is your basic currency:
+
+        rake spree_multi_currency:rates:ecb
+
+3. Rates from Google.
+
+        rake spree_multi_currency:rates:google[currency]
+
+The argument in square brackets is the iso code of your basic currency, so to load rates when US Dollar is your basic currency, use
+
+        rake spree_multi_currency:rates:google[usd]
+
+There's also an optional square-bracket-enclosed parameter "load_currencies" for :rates tasks above, but it just loads up currencies table from Wikipedia, so is not needed at this point.
+
+Settings
+---------
+In Spree Admin Panel, Configuration tab, two new options appear: Currency Settings and Currency Converters.
+
+It's best to leave Currency Converters as-is, to be populated and updated by rake spree_multi_currency:rates tasks.
+
+Within Currency Settings, like mentioned above, it is essential to set one currency as the Basic one. It's also necessary to set currency's locale for every locale you want to support (again, one locale - one currency).
+Feel free to go through currencies and delete the ones you don't want to support -- it will make everything easier to manage (and the :rates rake tasks will execute faster).
+
+Changing Currency in store
+--------------------------
+Self-explanatory:
+
+    http://[domain]/currency/[isocode]
+    <%= link_to "eur", currency_path(:eur) %>
+
+
+Translation files
+--------------------
+To have custom currency symbols and formatters, you need to have a corresponding entry in one of locale files, with main key like currency_XXX, where XXX is the 3-letter iso code of given currency.
+
+If you won't have it, all the other currencies will be rendered using default formatters and symbols, which can (will) lead to confusion and inconsistency. It is recommended to create locale entries for all currencies you want to support at your store and delete all the other currencies.
+
+Example for usd, eur
+
+    --
+    currency_USD: &usd
+      number:
+        currency:
+          format:
+            format: "%u%n"
+            unit: "$"
+            separator: "."
+            delimiter: ","
+            precision: 2
+            significant: false
+            strip_insignificant_zeros: false
+
+    currency_EUR:
+      <<: *usd
+      number:
+        currency:
+          format:
+            format: "%u%n"
+            unit: "€"
+
+
+
+
+= Multi Currency
+
+Support different currency and recalculate price from one to another
+===========================================
+Installation
+---------
+Add to Gemfile
+    gem "spree_multi_currency", :git => "git://github.com/pronix/spree-multi-currency.git"
+
+Run
+---
+    rake spree_multi_currency:install:migrations
+    rake db:migrate
+
+Load currencies:
+---------------
+    rake spree_multi_currency:currency:iso4217         # Load currency ISO4217 http://en.wikipedia.org/wiki/ISO_4217
+    rake spree_multi_currency:currency:okv             # Общероссийский классификатор валют...
+
+Load rates:
+----------
+    rake spree_multi_currency:rates:cbr                               # Курс Сбербанка РФ http://www.cbr.ru
+    rake "spree_multi_currency:rates:ecb[load_currencies]"              # Rates from European Central Bank
+  for example     rake spree_multi_currency:rates:google[USD]
+    rake "spree_multi_currency:rates:google[currency,load_currencies]"  # Rates from Google
+
+
+Settings
+---------
+        In admin block, configuration menu add two tables currency and currency conversion rate
+        In reference currency enters the list of currencies, indicate if one of the major currencies (in the currency keeps all prices). Each currency assign corresponding locale.
+        In Exchange Rates, provides information on the price of the currency on a specified date to the basic currency(from russian central bank).
+        In the exchange rates set date, currency, and face value of the currency in the base currency.
+        To fill in the exchange rate, you can use task for download exchange rates from the site of the Central Bank (http://www.cbr.ru):
+        rake spree_multi_currencies:rates:cbr, as in this problem, loading the list of currencies.
+
+        В справочнике Валюты заносим список валют, указываем одну из валют основной (в этой валюте хранятся все цены). Каждой валюте назначаем соответствующую локаль.
+        В справчнике Курсы валют, содержиться информация о цене валюты на определенную дату к основной валюте.
+        В курсе валют указываеться дата, валюта, номинал и стоимость валюты в основной валюте.
+        Для заполнения курса валют, можно воспользоватьбся задачей загрузки курса валют с сайта ЦБ(http://www.cbr.ru):
+        rake spree_multi_currencies:rates:cbr, так же в этой задаче идет загрузка списка валют.
+
+Смена валюты
+-------------
+ По умолчанию валюта выбирается от текущей локали сайта.
+ Так же можно сменить локаль по адресу http://[domain]/currency/[isocode], <%= link_to "eur", currency_path(:eur) %>
+
+ isocode: eur, usd, rub (цифровой код прописанные в справочнике валюты)
+ После смены валюты через url перестает работать смена валюты на основание текущей локали.
+
+Формат вывода валюты
+--------------------
+ Формат для валюты прописан в локализации, для каждой валюты нужно описать свою локализацию (прописаны eur, usd, rub):
+ Пример для usd, eur
+  ---
+  currency_USD: &usd
+    number:
+      currency:
+        format:
+          format: "%u%n"
+          unit: "$"
+          separator: "."
+          delimiter: ","
+          precision: 2
+          significant: false
+          strip_insignificant_zeros: false
+
+  currency_EUR:
+    <<: *usd
+    number:
+      currency:
+        format:
+          format: "%u%n"
+          unit: "€"
+
+
+For tests
+_________________________
+
+  extention require store in ./spree
+  in Rakefile defined
+  # require define path to spree project
+  ENV['SPREE_GEM_PATH'] = "/home/dima/project/spree"
+  # or define spree as gem in Gemfile
+  # and decomment this
+  # gemfile = Pathname.new("Gemfile").expand_path
+  # lockfile = gemfile.dirname.join('Gemfile.lock')
+  # definition = Bundler::Definition.build(gemfile, lockfile, nil)
+  # sc=definition.index.search "spree"
+  # ENV['SPREE_GEM_PATH'] = sc[0].loaded_from.gsub(/\/[a-z_]*.gemspec$/,'')
+
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree/core/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+
+spec = eval(File.read('spree_multi_currency.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Release to gemcutter"
+task :release do
+  version = File.read(File.expand_path("../../SPREE_VERSION", __FILE__)).strip
+  cmd = "cd pkg && gem push spree-multi-currency_-#{version}.gem"; puts cmd; system cmd
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_multi_currency'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,9 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+# Examples
+#
+"0.50.x" => { :branch => "master" }
+"0.40.x" => { :tag => "v1.0.0", :version => "1.0.0" }
+
+

data/app/controllers/spree/admin/currencies_controller.rb

@@ -0,0 +1,11 @@
+module Spree
+  class Admin::CurrenciesController < Admin::ResourceController
+    before_filter :set_currency, :only => [:edit, :update]
+
+    private
+
+    def set_currency
+      @currency = Spree::Currency.find(params[:id])
+    end
+  end
+end

data/app/controllers/spree/admin/currency_converters_controller.rb

@@ -0,0 +1,4 @@
+module Spree
+  class Admin::CurrencyConvertersController < Admin::ResourceController
+  end
+end

data/app/controllers/spree/base_controller_decorator.rb

@@ -0,0 +1,12 @@
+Spree::BaseController.class_eval do
+  before_filter :set_currency
+
+  private
+
+  def set_currency
+    if session[:currency_id].present? && (@currency = Spree::Currency.find_by_char_code(session[:currency_id]))
+      Spree::Currency.current!(@currency)
+    end
+  end
+
+end

data/app/controllers/spree/currency_controller.rb

@@ -0,0 +1,16 @@
+module Spree
+  class CurrencyController < Spree::BaseController
+
+    def set
+      if @currency = Spree::Currency.find_by_char_code(params[:id].to_s.upcase)
+        session[:currency_id] = params[:id].to_s.upcase.to_sym
+        Spree::Currency.current!(@currency)
+        flash.notice = t(:currency_changed)
+      else
+        flash[:error] = t(:currency_not_found)
+      end
+
+      redirect_back_or_default(root_path)
+    end
+  end
+end

data/app/helpers/number_helper_decorator.rb

@@ -0,0 +1,40 @@
+module ActionView
+  module Helpers
+    module NumberHelper
+
+      def number_to_currency(number, options = {})
+        return nil if number.nil?
+        options.symbolize_keys!
+        options[:locale] = "currency_#{ Spree::Currency.current.try(:char_code) || I18n.default_locale }"
+        defaults  = I18n.translate('number.format', :locale => options[:locale], :default => {})
+        currency  = I18n.translate('number.currency.format', :locale => options[:locale], :default => {})
+        defaults  = DEFAULT_CURRENCY_VALUES.merge(defaults).merge!(currency)
+        defaults[:negative_format] = "-" + options[:format] if options[:format]
+        options   = defaults.merge!(options)
+
+        unit      = options.delete(:unit)
+        format    = options.delete(:format)
+
+        if number.to_f < 0
+          format = options.delete(:negative_format)
+          number = number.respond_to?("abs") ? number.abs : number.sub(/^-/, '')
+        end
+
+        begin
+          value = number_with_precision(number, options.merge(:raise => true))
+          format.gsub(/%n/, value).gsub(/%u/, unit).html_safe
+        rescue InvalidNumberError => e
+          if options[:raise]
+            raise
+          else
+            formatted_number = format.gsub(/%n/, e.number).gsub(/%u/, unit)
+            e.number.to_s.html_safe? ? formatted_number.html_safe : formatted_number
+          end
+        end
+
+      end
+
+
+    end
+  end
+end

data/app/models/spree/adjustment_decorator.rb

@@ -0,0 +1,4 @@
+Spree::Adjustment.class_eval do
+  extend Spree::MultiCurrency
+  multi_currency :amount
+end

data/app/models/spree/currency.rb

@@ -0,0 +1,119 @@
+require 'money'
+class OriginMoney < Money
+end
+
+module Spree
+  class Currency < ActiveRecord::Base
+
+    has_many :currency_converters do
+      def get_rate(date)
+        last(:conditions => ["date_req <= ?", date])
+      end
+    end
+
+    default_scope :order => "spree_currencies.locale"
+    scope :locale, lambda{|str| where("locale like ?", "%#{str}%")}
+    after_save :reset_basic_currency
+
+    attr_accessible :basic, :locale, :char_code, :num_code, :name
+
+    def basic!
+      self.class.update_all(:basic => false) && update_attribute(:basic, true)
+    end
+
+    def locale=(locales)
+      write_attribute(:locale, [locales].flatten.compact.join(','))
+    end
+
+    def locale(need_split = true)
+      need_split ? read_attribute(:locale).to_s.split(',') : read_attribute(:locale).to_s
+    end
+
+    # We can only have one main currency.
+    # Therefore we reset all other currencies but the current if it's the main.
+    def reset_basic_currency
+      self.class.where("id != ?", self.id).update_all(:basic => false) if self.basic?
+    end
+
+    class << self
+
+      # Get the current locale
+      def current( current_locale = nil )
+        @current ||= locale(current_locale || I18n.locale).first
+      end
+
+      def current!(current_locale = nil )
+        @current = current_locale.is_a?(Spree::Currency) ? current_locale : locale(current_locale||I18n.locale).first
+      end
+
+      def load_rate(options= {})
+        current(options[:locale] || I18n.locale)
+        basic
+        if @rate = @current.currency_converters.get_rate(options[:date] || Time.now)
+          add_rate(@basic.char_code,   @current.char_code, @rate.nominal/@rate.value.to_f)
+          add_rate(@current.char_code, @basic.char_code,   @rate.value.to_f)
+        end
+      end
+
+      # Exchanges money between two currencies.
+      # E.g. with these args: 150, DKK, GBP returns 16.93
+      def convert(value, from, to)
+        res = ( OriginMoney.new(value.to_f * 10000, from).exchange_to(to).to_f / 100).round(2)
+        #Rails.logger.info "#{value} #{from} == #{res} #{to}"
+        res
+      end
+
+      # Converts the basic currency value to a 'localized' value.
+      # In the parameters you can specify the locale you wish to convert TO.
+      # Usage: Currency.conversion_to_current(100, :locale => "da")
+      def conversion_to_current(value, options = { })
+        load_rate(options)
+        convert(value, @basic.char_code, @current.char_code)
+      rescue => ex
+        Rails.logger.error " [ Currency ] :#{ex.inspect} \n #{ex.backtrace.join('\n ')}"
+        value
+      end
+
+      # Converts the currency value of the current locale to the basic currency.
+      # In the parameters you can specify the locale you wish to convert FROM.
+      # Usage: Currency.conversion_from_current(100, :locale => "da")
+      def conversion_from_current(value, options={})
+        load_rate(options)
+
+        # Replace commas with dots as decimal mark for those languages that use this.
+
+        # 2,000.00 => 2000.00
+        value.gsub!(",","") if (value =~ /\,[0-9]+\./)
+
+        # 2.000,00 => 2000.00
+        value.gsub!(".","").gsub!(",",".") if (value =~ /\.[0-9]+\,/)
+
+        # 2000,00 => 2000.00
+        value.gsub!(",","") if (value =~ /\.[0-9]+\,/)
+
+        convert(value, @current.char_code, @basic.char_code)
+      rescue => ex
+        Rails.logger.error " [ Currency ] :#{ex.inspect} \n #{e.backtrace.join('\n ')}"
+        value
+      end
+
+
+      # Retrieves the main currency.
+      def basic
+        @basic ||= where(:basic => true).first
+      end
+
+      def get(num_code, options ={ })
+        find_by_num_code(num_code) || create(options)
+      end
+
+      private
+
+      def add_rate(from, to, rate)
+        OriginMoney.add_rate(from, to, rate.to_f )
+      end
+
+    end
+
+  end
+end