spree_price 3.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48cb223d2b3c405236743e13146782f898967245dd2ac3d25cf6e0869cfdfc66
+  data.tar.gz: 99334096c7a58e696e3188098f5506c74aeabcfc2e47ade2ae1c01d8561f48e7
+SHA512:
+  metadata.gz: 66027887b1514bb4658a575ad4e717233fd76f2ad28f22911164c35112cc6c866889f4fbee122955aa828e00eb6b13d1d99a5e62f6febd522e6fc9374cec0736
+  data.tar.gz: 24d3611554d5c320265685fcaff8d9de5697e1acb48e5b78d7a3c65fb32d0e41ad0386ae8c8706151e5fe6feddbf68cddc49347c2e952d644d13262f5f34ad00

data/README.md

@@ -0,0 +1,83 @@
+# Spree Price
+
+Heavily inspired by [spree-contrib/spree_price_book](https://github.com/spree-contrib/spree_price_books).
+1. Support multiple store price
+2. Support multiple type of prices (e.g. sales price, marked price, manufacturer's suggested retail price
+3. Support price book. Price book can be prioritized at store.
+4. Auto adjust prices according to exchange rate. 
+5. Price is found by the following order.
+    - Manual set price
+    - Price book with higher priority in the same store
+    - First price matching the currency and price type
+    - First price matching the currency
+    TODO: Find the price from parent price type without sacrificing the performance too much
+
+6. The price will not be populated from parent price type by default. You can either fill nil prices from parent price book with adjustment factor or refresh all prices from parent price book in admin panel.
+
+7. Line item and order will save all prices for each price type.
+
+### Usage
+Create your own price type
+![Price Type](/docs/price-type-1.png?raw=true "Price Type")
+
+Create your own price book for each currency, price type, store, user roles
+![Price Book](/docs/price-book-1.png?raw=true "Price Book")
+
+You can update the prices in price book from parent price book, either filling nil prices from parent price book with adjustment factor or refreshing all prices in price book.
+![Price Book](/docs/price-book-details-1.png?raw=true "Price Book")
+
+Update the price from product page with store, price type and role filter. If the price is not set manually, it will show you the reference price. 
+![Variant Prices](/docs/variant-prices.png?raw=true "Variant Prices")
+
+### Installation
+Add spree_price_books to your Gemfile:
+
+```shell
+gem 'spree_price', github: 'EONIQ/spree_price'
+```
+
+Bundle your dependencies and run the installation generator:
+```shell
+bundle
+bundle exec rails g spree_price:install
+```
+
+### Configuration
+Once installed you can seed default currency exchange rates via open exchange rate
+
+Get your app id from https://openexchangerates.org/signup
+
+Add open_exchange_rate.rb to config/initializers
+```ruby
+Rails.application.config.openExchangeRate = {
+  appId: 'YOUR APP ID HERE',
+}
+```
+
+```shell
+bundle exec rake spree_price:currency_rates
+```
+
+### Testing
+TODO: Need to work on rspec
+
+First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using rake test_app.
+
+On the first run you may need to create the Postgresql role (ex. createuser -d postgres)
+
+```
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories. Simply add this require statement to your spec_helper:
+
+```
+require 'spree_price/factories'
+```
+
+### Credit
+[spree/spree](https://github.com/spree/spree)
+[spree-contrib/spree_price_book](https://github.com/spree-contrib/spree_price_books)
+
+Copyright (c) 2018 EONIQ (HK) LIMITED, released under the New BSD License

data/app/assets/javascripts/spree/backend/price.js.coffee

@@ -0,0 +1,13 @@
+$ ->
+  appendParams = (key, value) ->
+    path = window.location.pathname;
+    url = Spree.url(path + window.location.search).deleteQueryParam(key).addQueryParam(key, value)
+    
+    window.location.href = url.toString();
+
+  $('#select_variant_prices_store').on 'change', (event) ->
+    appendParams('store_id', event.val)
+  $('#select_variant_prices_price_type').on 'change', (event) ->
+    appendParams('price_type_id', event.val)
+  $('#select_variant_prices_role').on 'change', (event) ->
+    appendParams('role_id', event.val)

data/app/assets/javascripts/spree/backend/price_book.js.coffee

@@ -0,0 +1,104 @@
+$ ->
+  class PriceBookVariant
+    constructor: (@variant) ->
+      @id = @variant.id
+      @name = "#{@variant.name} - #{@variant.sku}"
+      @price = 0.0
+
+    update: (price) ->
+      @price = price
+
+  class PriceBookVariants
+    constructor: ->
+      @build_select(Spree.url(Spree.routes.variants_api), 'product_name_or_sku_cont')
+
+    format_variant_result: (result) ->
+      "#{result.name} - #{result.sku}"
+
+    build_select: (url, query) ->
+      $('#price_book_variant').select2
+        minimumInputLength: 3
+        ajax:
+          url: url
+          datatype: "json"
+          data: (term, page) ->
+            query_object = {}
+            query_object[query] = term
+            q: query_object
+            token: Spree.api_key
+
+          results: (data, page) ->
+            result = data["variants"]
+            window.variants = result
+            results: result
+
+        formatResult: @format_variant_result
+        formatSelection: (variant) ->
+          if !!variant.options_text
+            variant.name + " (#{variant.options_text})" + " - #{variant.sku}"
+          else
+            variant.name + " - #{variant.sku}"
+
+  class PriceBookAddVariants
+    constructor: ->
+      @variants = []
+      if $('#price_book_variant_template').length > 0 
+        @template = Handlebars.compile $('#price_book_variant_template').html()
+
+      $('button.price_book_add_variant').click (event) =>
+        event.preventDefault()
+        if $('#price_book_variant').select2('data')?
+          @add_variant()
+        else
+          alert('Please select a variant first')
+      
+      $('#price_book-variants-table').on 'click', '.price_book_remove_variant', (event) =>
+        event.preventDefault()
+        @remove_variant $(event.target)
+
+      $('button.price_book_new_push').click =>
+        unless @variants.length > 0
+          alert('no variants to transfer')
+          false
+
+    add_variant: ->
+      variant = $('#price_book_variant').select2('data')
+      price = $('#price_book_variant_price').val()
+
+      variant = @find_or_add(variant)
+      variant.update(price)
+      @render()
+
+    find_or_add: (variant) ->
+      if existing = _.find(@variants, (v) -> v.id == variant.id)
+        return existing
+      else
+        variant = new PriceBookVariant($.extend({}, variant))
+        @variants.push variant
+        return variant
+
+    remove_variant: (target) ->
+      variant_id = parseInt(target.data('variantId'))
+      @variants = (v for v in @variants when v.id isnt variant_id)
+      @render()
+    
+    clear_variants: ->
+      @variants = []
+      @render()
+
+    contains: (id) ->
+      _.contains(_.pluck(@variants, 'id'), id)
+
+    render: ->
+      if @variants.length is 0
+        $('#price_book-variants-table').hide()
+        $('.no-objects-found').show()
+      else
+        $('#price_book-variants-table').show()
+        $('.no-objects-found').hide()
+
+        rendered = @template { variants: @variants }
+        $('#price_book_variants_tbody').html(rendered)
+
+  price_book_add_variants = new PriceBookAddVariants
+  price_book_variants = new PriceBookVariants

data/app/assets/javascripts/spree/backend/spree_price.js

@@ -0,0 +1,2 @@
+//= require spree/backend/price_book
+//= require spree/backend/price

data/app/assets/javascripts/spree/frontend/spree_price.js

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_price.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/spree_price.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

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

@@ -0,0 +1,11 @@
+module Spree
+  module Admin
+    class CurrencyRatesController < Spree::Admin::ResourceController
+      def fetch
+        Spree::CurrencyRate.update_from_open_exchange
+        flash[:success] = Spree.t('notice_messages.currency_rate_fetched')
+        redirect_to admin_currency_rates_path
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Spree
+  module Admin
+    class PriceBooksController < Spree::Admin::ResourceController
+      def show
+        @prices = @price_book
+          .prices
+          .includes(variant: [{ option_values: :option_type }, :product])
+          .page(params[:page])
+      end
+
+      def update_price
+        @price_book.update_attributes(prices_params)
+        redirect_to admin_price_book_path(@price_book)
+      end
+
+      def add_price
+        prices_params[:prices_attributes].each do |price_param|
+          price = @price_book.prices.find_or_initialize_by(
+            currency: @price_book.currency,
+            variant_id: price_param[:variant_id].to_i,
+          )
+          price.amount = price_param[:amount].to_f
+          price.save!
+        end
+        redirect_to admin_price_book_path(@price_book)
+      end
+
+      def load_from_parent
+        @price_book.load_prices_from_parent(!params[:force_update].nil?)
+
+        flash[:success] = Spree.t('notice_messages.price_book_loaded_from_parent')
+        redirect_to admin_price_book_path(@price_book)
+      end
+
+      private
+      def prices_params
+        params.require(:price_book).permit(prices_attributes: [:id, :amount, :variant_id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class PriceTypesController < Spree::Admin::ResourceController
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+Spree::Admin::PricesController.class_eval do
+  before_action :load_extra, only: [:index, :variant_prices]
+
+  def load_extra
+    @store = params[:store_id] ? Spree::Store.find(params[:store_id]) : Spree::Store.first
+    @price_type = params[:price_type_id] ? Spree::PriceType.find(params[:price_type_id]) : Spree::PriceType.first
+    @role = params[:role_id] ? Spree::Role.find(params[:role_id]) : Spree::Role.first
+  end
+
+  def variant_prices
+    @product = Spree::Product.friendly.find(params[:product_id])
+
+    variant_prices_params.each do |variant_id, price_params|
+      price_params.each do |currency, amount|
+        if amount.present?
+          price_book = @store
+            .price_books
+            .by_currency(currency.upcase)
+            .by_price_type(@price_type.try(:id))
+            .by_roles([@role.try(:id)])
+            .first
+          price_book = price_book || Spree::PriceBook
+            .by_currency(currency)
+            .by_price_type(@price_type.try(:id))
+            .first
+
+          price = Spree::Price.find_or_initialize_by(
+            currency: currency.upcase,
+            variant_id: variant_id,
+            price_book_id: price_book.try(:id)
+          )
+
+          price.amount = amount.to_f
+          price.save!
+        end
+      end
+    end
+
+    flash[:success] = Spree.t('notice_messages.variant_price_updated')
+    redirect_to admin_product_prices_path(
+      @product,
+      store_id: @store.try(:id),
+      role_id: @role.try(:id),
+      price_type_id: @price_type.try(:id)
+    )
+  end
+
+  private
+  def variant_prices_params
+    params.require(:vp).tap do |whitelisted|
+      whitelisted = params[:vp]
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+Spree::Admin::StoresController.class_eval do
+  def update_price_book_positions
+    Spree::PriceBook.transaction do
+      params[:positions].each do |id, index|
+        Spree::StorePriceBook
+          .where(price_book_id: id, store_id: params[:id])
+          .update_all(priority: index)
+      end
+    end
+
+    respond_to do |format|
+      format.html { redirect_to admin_stores_url(params[:id]) }
+      format.js { render plain: 'Ok' }
+    end
+  end
+end

data/app/helpers/spree/base_helper_decorator.rb

@@ -0,0 +1,32 @@
+Spree::BaseHelper.class_eval do
+  def supported_currencies_options
+    supported_currencies.map do |currency|
+      iso = currency.iso_code
+      ["#{currency.name} (#{iso})", iso]
+    end
+  end
+
+  def price_types_options
+    Spree::PriceType.all.map do |price_type|
+      ["#{price_type.name} (#{price_type.code})", price_type.id]
+    end
+  end
+
+  def stores_options
+    Spree::Store.all.map do |store|
+      ["#{store.name} (#{store.code})", store.id]
+    end
+  end
+
+  def roles_options
+    Spree::Role.all.map do |role|
+      [role.name, role.id]
+    end
+  end
+
+  def roles_to_s(roles)
+    if roles && !roles.empty?
+      roles.map(&:name).join(', ')
+    end
+  end
+end

data/app/models/spree/currency_rate.rb

@@ -0,0 +1,56 @@
+class Spree::CurrencyRate < Spree::Base
+  validates :base_currency, presence: true
+  validates :currency, presence: true, uniqueness: { scope: :base_currency }
+  validates :exchange_rate, presence: true
+  validate :validate_single_default
+
+  def self.create_default
+    create(base_currency: Spree::Config[:currency], currency: Spree::Config[:currency], default: true)
+  end
+
+  def self.default
+    if default = where(default: true).first
+      default
+    else
+      create_default
+    end
+  end
+
+  def self.update_from_open_exchange
+    oxr = Money::Bank::OpenExchangeRatesBank.new
+    oxr.app_id = Rails.application.config.openExchangeRate[:appId]
+    oxr.update_rates
+    oxr.cache = 'tmp/cache.json'
+    oxr.ttl_in_seconds = 86400
+    oxr.source = Spree::CurrencyRate.default.currency
+    Money.default_bank = oxr
+
+    Spree::Config[:supported_currencies].split(',').each do |currencyCode|
+      logger.debug "Fetching currency #{currencyCode} from OpenExchange"
+      currency = Money::Currency.new(currencyCode)
+      rate = Money.default_bank.get_rate(Spree::CurrencyRate.default.currency, currency)
+      currencyRate = Spree::CurrencyRate.find_or_create_by(
+        base_currency: Spree::CurrencyRate.default.currency,
+        currency: currency.iso_code,
+        default: (Spree::Config[:currency] == currency.iso_code)
+      )
+      currencyRate.update_attribute(:exchange_rate, rate) if currencyRate
+      logger.debug "Currency #{currencyCode} rate updated: #{rate}"
+    end
+  end
+
+  private
+  def validate_single_default
+    return unless default?
+
+    matches = self.class.where(default: true)
+
+    if persisted?
+      matches = matches.where('id != ?', id)
+    end
+
+    if matches.exists?
+      errors.add(:default, 'cannot have multiple defaults.')
+    end
+  end
+end