spree_payment_calculator 0.70.0

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,18 @@
+SpreePaymentCalculator
+======================
+
+Added a calculator for PaymentMethod for Spree
+
+
+Basic Installation
+------------------
+
+1. Add the following to your Gemfile
+<pre>
+  gem 'spree_payment_calculator', '~> 0.70.0'
+</pre>
+2. Run `bundle install`
+3. Go to Payment Method in the Admin panel and add a calculator for each type of payment you prefer
+
+
+Copyright (c) 2012 [Damiano Giacomello], released under the New BSD License

data/app/assets/javascripts/admin/spree_payment_calculator.js

@@ -0,0 +1 @@
+//= require admin/spree_core

data/app/assets/javascripts/store/spree_payment_calculator.js

@@ -0,0 +1 @@
+//= require store/spree_core

data/app/assets/stylesheets/admin/spree_payment_calculator.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/app/assets/stylesheets/store/spree_payment_calculator.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_core
+*/

data/app/model/payment_calculator/flat_percent_item_total.rb

@@ -0,0 +1,20 @@
+class PaymentCalculator::FlatPercentItemTotal < Calculator
+  preference :flat_percent, :decimal, :default => 0
+  
+  # Register the calculator
+  def self.register
+    super
+    PaymentMethod.register_calculator(self)
+  end
+  
+  def self.description
+    I18n.t("flat_percent")
+  end
+
+  def compute(object)
+    return unless object.present? and object.line_items.present?
+    item_total = object.line_items.map(&:amount).sum
+    value = item_total * self.preferred_flat_percent / 100.0
+    (value * 100).round.to_f / 100
+  end
+end

data/app/model/payment_calculator/flat_rate.rb

@@ -0,0 +1,17 @@
+class PaymentCalculator::FlatRate < Calculator
+  preference :amount, :decimal, :default => 0
+  
+  # Register the calculator
+  def self.register
+    super
+    PaymentMethod.register_calculator(self)
+  end
+  
+  def self.description
+    I18n.t("flat_rate_per_order")
+  end
+
+  def compute(object=nil)
+    self.preferred_amount
+  end
+end

data/app/model/payment_calculator/flexi_rate.rb

@@ -0,0 +1,33 @@
+class PaymentCalculator::FlexiRate < Calculator
+  preference :first_item,      :decimal, :default => 0
+  preference :additional_item, :decimal, :default => 0
+  preference :max_items,       :decimal, :default => 0
+  
+  # Register the calculator
+  def self.register
+    super
+    PaymentMethod.register_calculator(self)
+  end
+  
+  def self.description
+    I18n.t("flexible_rate")
+  end
+
+  def self.available?(object)
+    true
+  end
+
+  def compute(object)
+    sum = 0
+    max = self.preferred_max_items
+    items_count = object.line_items.map(&:quantity).sum
+    items_count.times do |i|
+      if (i % max == 0) && (max > 0)
+        sum += self.preferred_first_item
+      else
+        sum += self.preferred_additional_item
+      end
+    end
+    return(sum)
+  end
+end

data/app/model/payment_calculator/per_item.rb

@@ -0,0 +1,17 @@
+class PaymentCalculator::PerItem < Calculator
+  preference :amount, :decimal, :default => 0
+  
+  # Register the calculator
+  def self.register
+    super
+    PaymentMethod.register_calculator(self)
+  end
+  
+  def self.description
+    I18n.t("flat_rate_per_item")
+  end
+
+  def compute(object=nil)
+    self.preferred_amount * object.line_items.length
+  end
+end

data/app/model/payment_calculator/price_sack.rb

@@ -0,0 +1,30 @@
+class PaymentCalculator::PriceSack < Calculator
+  preference :minimal_amount, :decimal, :default => 0
+  preference :normal_amount, :decimal, :default => 0
+  preference :discount_amount, :decimal, :default => 0
+  
+  # Register the calculator
+  def self.register
+    super
+    PaymentMethod.register_calculator(self)
+  end
+  
+  def self.description
+    I18n.t("price_sack")
+  end
+
+  # as object we always get line items, as calculable we have Coupon, ShippingMethod
+  def compute(object)
+    if object.is_a?(Array)
+      base = object.map{ |o| o.respond_to?(:amount) ? o.amount : o.to_d }.sum
+    else
+      base = object.respond_to?(:amount) ? object.amount : object.to_d
+    end
+
+    if base >= self.preferred_minimal_amount
+      self.preferred_normal_amount
+    else
+      self.preferred_discount_amount
+    end
+  end
+end

data/app/model/payment_decorator.rb

@@ -0,0 +1,26 @@
+Payment.class_eval do
+  has_one :adjustment, :as => :source
+  before_save :remove_old_adjustment
+  after_save :ensure_correct_adjustment, :update_order, :if => Proc.new {|p| !p.payment_method.calculator.blank?}
+  
+  private
+  def remove_old_adjustment
+    order.adjustments.each do |adjustment|
+      adjustment.destroy if adjustment.source_type == "Payment"
+    end
+  end
+  
+  def ensure_correct_adjustment
+    if adjustment
+      adjustment.originator = payment_method
+      adjustment.save
+    else
+      payment_method.create_adjustment(I18n.t(:payment_adjustment), order, self, true)
+      reload #ensure adjustment is present on later saves
+    end
+  end
+
+  def update_order
+    order.update!
+  end
+end

data/app/model/payment_method_decorator.rb

@@ -0,0 +1,3 @@
+PaymentMethod.class_eval do
+  calculated_adjustments
+end

data/app/overrides/add_calculators_to_payment_methods.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => 'admin/payment_methods/_form',
+                     :name => 'add_calculators_to_payment_methods',
+                     :insert_before => %q{[id='preference-settings']}, 
+                     :text => %q{<% @calculators = PaymentMethod.calculators.sort_by(&:name) rescue nil %><%= render :partial => 'admin/shared/calculator_fields', :locals => {:f => f}},
+                     :disabled => false)

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+---
+en:
+  payment_cost: "Fixed Costs by Type of Payment"

data/config/locales/it.yml

@@ -0,0 +1,3 @@
+---
+en:
+  payment_cost: "Costi Fissi per Tipologia di Pagamento"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  # Add your extension routes here
+end

data/lib/generators/spree_payment_calculator/install/install_generator.rb

@@ -0,0 +1,29 @@
+module SpreePaymentCalculator
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        #append_file "app/assets/javascripts/store/all.js", "//= require store/spree_payment_calculator\n"
+        #append_file "app/assets/javascripts/admin/all.js", "//= require admin/spree_payment_calculator\n"
+      end
+
+      def add_stylesheets
+        #inject_into_file "app/assets/stylesheets/store/all.css", " *= require store/spree_payment_calculator\n", :before => /\*\//, :verbose => true
+        #inject_into_file "app/assets/stylesheets/admin/all.css", " *= require admin/spree_payment_calculator\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_payment_calculator'
+      end
+
+      def run_migrations
+         res = ask "Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'bundle exec rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+    end
+  end
+end

data/lib/spree/environment/calculators.rb

@@ -0,0 +1,9 @@
+module Spree
+  class Environment
+    class Calculators
+      include EnvironmentExtension
+
+      attr_accessor :shipping_methods, :tax_rates, :payment_methods
+    end
+  end
+end

data/lib/spree_payment_calculator/engine.rb

@@ -0,0 +1,37 @@
+module SpreePaymentCalculator
+  class Engine < Rails::Engine
+    engine_name 'spree_payment_calculator'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+      
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+      
+      Dir.glob(File.join(File.dirname(__FILE__), "../../lib/spree/environment/calculator.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+    initializer 'spree.register.calculators' do |app|
+      app.config.spree.calculators.payment_methods = [
+        PaymentCalculator::PriceSack,
+        PaymentCalculator::FlatPercentItemTotal,
+        PaymentCalculator::FlatRate,
+        PaymentCalculator::FlexiRate,
+        PaymentCalculator::PerItem
+      ]
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_payment_calculator.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_payment_calculator/engine'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: spree_payment_calculator
+version: !ruby/object:Gem::Version
+  version: 0.70.0
+  prerelease: 
+platform: ruby
+authors:
+- Damiano Giacomello
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.70.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.70.5
+- !ruby/object:Gem::Dependency
+  name: spree_auth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.70.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.70.5
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: damiano.giacomello@diginess.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/generators/spree_payment_calculator/install/install_generator.rb
+- lib/spree/environment/calculators.rb
+- lib/spree_payment_calculator/engine.rb
+- lib/spree_payment_calculator.rb
+- app/assets/javascripts/admin/spree_payment_calculator.js
+- app/assets/javascripts/store/spree_payment_calculator.js
+- app/assets/stylesheets/admin/spree_payment_calculator.css
+- app/assets/stylesheets/store/spree_payment_calculator.css
+- app/model/payment_calculator/flat_percent_item_total.rb
+- app/model/payment_calculator/flat_rate.rb
+- app/model/payment_calculator/flexi_rate.rb
+- app/model/payment_calculator/per_item.rb
+- app/model/payment_calculator/price_sack.rb
+- app/model/payment_decorator.rb
+- app/model/payment_method_decorator.rb
+- app/overrides/add_calculators_to_payment_methods.rb
+- config/locales/en.yml
+- config/locales/it.yml
+- config/routes.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.22
+signing_key: 
+specification_version: 3
+summary: Added a calculator for PaymentMethod for Spree
+test_files: []